home *** CD-ROM | disk | FTP | other *** search
/ Aminet 48 / Aminet 48 (2002)(GTI - Schatztruhe)[!][Apr 2002].iso / Aminet / text / edit / vim60rt.lha / Vim / vim60 / doc / options.txt < prev    next >
Encoding:
Text File  |  2001-09-26  |  262.8 KB  |  6,278 lines
  1. *options.txt*   For Vim version 6.0.  Last change: 2001 Sep 26
  2.  
  3.  
  4.           VIM REFERENCE MANUAL    by Bram Moolenaar
  5.  
  6.  
  7. Options                            *options*
  8.  
  9. 1. Setting options            |set-option|
  10. 2. Automatically setting options    |auto-setting|
  11. 3. Options summary            |option-summary|
  12.  
  13. For an overview of options see help.txt |option-list|.
  14.  
  15. Vim has a number of internal variables and switches which can be set to
  16. achieve special effects.  These options come in three forms:
  17.     boolean        can only be on or off        *boolean* *toggle*
  18.     number        has a numeric value
  19.     string        has a string value
  20.  
  21. ==============================================================================
  22. 1. Setting options                    *set-option*
  23.  
  24.                             *:se* *:set*
  25. :se[t]            Show all options that differ from their default value.
  26.  
  27. :se[t] all        Show all but terminal options.
  28.  
  29. :se[t] termcap        Show all terminal options.  Note that in the GUI the
  30.             key codes are not shown, because they are generated
  31.             internally and can't be changed.  Changing the terminal
  32.             codes in the GUI is not useful either...
  33.  
  34. :se[t] {option}?    Show value of {option}.
  35.  
  36. :se[t] {option}        Toggle option: set, switch it on.
  37.             Number option: show value.
  38.             String option: show value.
  39.  
  40. :se[t] no{option}    Toggle option: Reset, switch it off.
  41.  
  42. :se[t] {option}!   or
  43. :se[t] inv{option}    Toggle option: Invert value. {not in Vi}
  44.  
  45.                 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
  46. :se[t] {option}&    Reset option to its default value.  May Depend on the
  47.             current value of 'compatible'. {not in Vi}
  48. :se[t] {option}&vi    Reset option to its Vi default value. {not in Vi}
  49. :se[t] {option}&vim    Reset option to its Vim default value. {not in Vi}
  50.  
  51. :se[t] all&        Set all options, except terminal options, to their
  52.             default value.  The values of 'term', 'lines' and
  53.             'columns' are not changed. {not in Vi}
  54.  
  55. :se[t] {option}={value}        or
  56. :se[t] {option}:{value}
  57.             Set string or number option to {value}.
  58.                                 *:set-args*
  59.             For numeric options the value can be given in decimal,
  60.             hex (preceded with 0x) or octal (preceded with '0')
  61.             (hex and octal are only available for machines which
  62.             have the strtol() function).
  63.             The old value can be inserted by typing 'wildchar' (by
  64.             default this is a <Tab> or CTRL-E if 'compatible' is
  65.             set).  See |cmdline-completion|.
  66.             White space between {option} and '=' is allowed and
  67.             will be ignored.  White space between '=' and {value}
  68.             is not allowed.
  69.             See |option-backslash| for using white space and
  70.             backslashes in {value}.
  71.  
  72. :se[t] {option}+={value}                *:set+=*
  73.             Add the {value} to a number option, or append the
  74.             {value} to a string option.  When the option is a
  75.             comma separated list, a comma is added, unless the
  76.             value was empty.
  77.             If the option is a list of flags, superfluous flags
  78.             are removed.  Otherwise there is no check for doubled
  79.             values.  You can avoid this by removing a value first.
  80.             Example: >
  81.                 :set guioptions-=T guioptions+=T
  82. <            Also see |:set-args| above.
  83.             {not in Vi}
  84.  
  85. :se[t] {option}^={value}                *:set^=*
  86.             Multiply the {value} to a number option, or prepend
  87.             the {value} to a string option.  When the option is a
  88.             comma separated list, a comma is added, unless the
  89.             value was empty.
  90.             Also see |:set-args| above.
  91.             {not in Vi}
  92.  
  93. :se[t] {option}-={value}                *:set-=*
  94.             Subtract the {value} from a number option, or remove
  95.             the {value} from a string option, if it is there.
  96.             If the {value} is not found in a string option, there
  97.             is no error or warning.  When the option is a comma
  98.             separated list, a comma is deleted, unless the option
  99.             becomes empty.
  100.             When the option is a list of flags, {value} must be
  101.             exactly as they appear in the option.  Remove flags
  102.             one by one to avoid problems.
  103.             Also see |:set-args| above.
  104.             {not in Vi}
  105.  
  106. The {option} arguments to ":set" may be repeated.  For example: >
  107.     :set ai nosi sw=3 ts=3
  108. If you make an error in one of the arguments, an error message will be given
  109. and the following arguments will be ignored.
  110.  
  111.                             *:set-verbose*
  112. When 'verbose' is non-zero, displaying an option value will also tell where it
  113. was last set.  Example: >
  114.     :verbose set shiftwidth cindent?
  115.       shiftwidth=4
  116.           Last set from modeline
  117.       cindent
  118.           Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
  119. This is only done when specific option values are requested, not for ":set
  120. all" or ":set" without an argument.
  121. When the option was set by hand there is no "Last set" message.  There is only
  122. one value for all local options with the same name.  Thus the message applies
  123. to the option name, not necessarily its value.
  124. When the option was set while executing a function, user command or
  125. autocommand, the script in which it was defined is reported.
  126. {not available when compiled without the +eval feature}
  127.  
  128.                             *:set-termcap*
  129. For {option} the form "t_xx" may be used to set a termcap option.  This will
  130. override the value from the termcap.  You can then use it in a mapping.  If
  131. the "xx" part contains special characters, use the <t_xx> form: >
  132.     :set <t_#4>=^[Ot
  133. This can also be used to translate a special code for a normal key.  For
  134. example, if Alt-b produces <Esc>b, use this: >
  135.     :set <M-b>=^[b
  136. (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
  137. The advantage over a mapping is that it works in all situations.
  138.  
  139. The listing from ":set" looks different from Vi.  Long string options are put
  140. at the end of the list.  The number of options is quite large.  The output of
  141. "set all" probably does not fit on the screen, causing Vim to give the
  142. |more-prompt|.
  143.  
  144.                             *option-backslash*
  145. To include white space in a string option value it has to be preceded with a
  146. backslash.  To include a backslash you have to use two.  Effectively this
  147. means that the number of backslashes in an option value is halved (rounded
  148. down).
  149. A few examples: >
  150.    :set tags=tags\ /usr/tags        results in "tags /usr/tags"
  151.    :set tags=tags\\,file        results in "tags\,file"
  152.    :set tags=tags\\\ file        results in "tags\ file"
  153.  
  154. The "|" character separates a ":set" command from a following command.  To
  155. include the "|" in the option value, use "\|" instead.  This example sets the
  156. 'titlestring' option to "hi|there": >
  157.    :set titlestring=hi\|there
  158. This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
  159.    :set titlestring=hi|set iconstring=there
  160.  
  161. For MS-DOS and WIN32 backslashes in file names are mostly not removed.  More
  162. precise: For options that expect a file name (those where environment
  163. variables are expanded) a backslash before a normal file name character is not
  164. removed.  But a backslash before a special character (space, backslash, comma,
  165. etc.) is used like explained above.
  166. There is one special situation, when the value starts with "\\": >
  167.    :set dir=\\machine\path        results in "\\machine\path"
  168.    :set dir=\\\\machine\\path        results in "\\machine\path"
  169.    :set dir=\\path\\file        results in "\\path\file" (wrong!)
  170. For the first one the start is kept, but for the second one the backslashes
  171. are halved.  This makes sure it works both when you expect backslashes to be
  172. halved and when you expect the backslashes to be kept.  The third gives a
  173. result which is probably not what you want.  Avoid it.
  174.  
  175.                 *add-option-flags* *remove-option-flags*
  176. Some options are a list of flags.  When you want to add a flag to such an
  177. option, without changing the existing ones, you can do it like this: >
  178.    :set guioptions+=a
  179. Remove a flag from an option like this: >
  180.    :set guioptions-=a
  181. This removes the 'a' flag from 'guioptions'.
  182. Note that you should add or remove one flag at a time.  If 'guioptions' has
  183. the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
  184. doesn't appear.
  185.  
  186.                *:set_env* *expand-env* *expand-environment-var*
  187. Environment variables in most string options will be expanded.  If the
  188. environment variable exists the '$' and the following environment variable
  189. name is replaced with its value.  If it does not exist the '$' and the name
  190. are not modified.  Any non-id character (not a letter, digit or '_') may
  191. follow the environment variable name.  That character and what follows is
  192. appended to the value of the environment variable.  Examples: >
  193.    :set term=$TERM.new
  194.    :set path=/usr/$INCLUDE,$HOME/include,.
  195. When adding or removing a string from an option with ":set opt-=val" or ":set
  196. opt+=val" the expansion is done before the adding or removing.
  197.  
  198.  
  199. Handling of local options            *local-options*
  200.  
  201. Some of the options only apply to a window or buffer.  Each window or buffer
  202. has its own copy of this option, thus can each have their own value.  This
  203. allows you to set 'list' in one window but not in another.  And set
  204. 'shiftwidth' to 3 in one buffer and 4 in another.
  205.  
  206. The following explains what happens to these local options in specific
  207. situations.  You don't really need to know all of this, since Vim mostly uses
  208. the option values you would expect.  Unfortunately, doing what the user
  209. expects is a bit complicated...
  210.  
  211. When splitting a window, the local options are copied to the new window.  Thus
  212. right after the split the contents of the two windows look the same.
  213.  
  214. When editing a new buffer, its local option values must be initialized.  Since
  215. the local options of the current buffer might be specifically for that buffer,
  216. these are not used.  Instead, for each buffer-local option there also is a
  217. global value, which is used for new buffers.  With ":set" both the local and
  218. global value is changed.  With "setlocal" only the local value is changed,
  219. thus this value is not used when editing a new buffer.
  220.  
  221. When editing a buffer that has been edited before, the last used window
  222. options are used again.  If this buffer has been edited in this window, the
  223. values from back then are used.  Otherwise the values from the window where
  224. the buffer was edited last are used.
  225.  
  226. It's possible to set a local window option specifically for a type of buffer.
  227. When you edit another buffer in the same window, you don't want to keep
  228. using these local window options.  Therefore Vim keeps a global value of the
  229. local window options, which is used when editing another buffer.  Each window
  230. has its own copy of these values.  Thus these are local to the window, but
  231. global to all buffers in the window.  With this you can do: >
  232.     :e one
  233.     :set list
  234.     :e two
  235. Now the 'list' option will also be set in "two", since with the ":set list"
  236. command you have also set the global value. >
  237.     :set nolist
  238.     :e one
  239.     :setlocal list
  240.     :e two
  241. Now the 'list' option is not set, because ":set nolist" resets the global
  242. value, ":setlocal list" only changes the local value and ":e two" gets the
  243. global value.  Note that if you do this next: >
  244.     :e one
  245. You will not get back the 'list' value as it was the last time you edited
  246. "one".  The options local to a window are not remembered for each buffer.
  247.  
  248.                             *:setl* *:setlocal*
  249. :setl[ocal] ...        Like ":set" but set only the value local to the
  250.             current buffer or window (if there is one).
  251.             With the "all" argument: display all local option's
  252.             local values.
  253.             Without argument: Display all local option's local
  254.             values which are different from the default.
  255.             When displaying a specific local option, show the
  256.             local value.  For a global option the global value is
  257.             shown (but that might change in the future).
  258.             {not in Vi}
  259.  
  260. :setl[ocal] {option}<    Set the local value of {option} to its global value.
  261.             {not in Vi}
  262.  
  263.                             *:setg* *:setglobal*
  264. :setg[lobal] ...    Like ":set" but set only the global value for a local
  265.             option without changing the local value.
  266.             When displaying an option, the global value is shown.
  267.             With the "all" argument: display all local option's
  268.             global values.
  269.             Without argument: display all local option's global
  270.             values which are different from the default.
  271.             {not in Vi}
  272.  
  273. For buffer-local and window-local options:
  274.     Command         global value       local value ~
  275.       :set option=value         set        set
  276.  :setlocal option=value          -            set
  277. :setglobal option=value         set         -
  278.       :set option          -               display
  279.  :setlocal option          -               display
  280. :setglobal option        display         -
  281.  
  282.  
  283. Global options with a local value            *global-local*
  284.  
  285. Options are global when you mostly use one value for all buffers.  For some
  286. global options it's useful to sometimes have a different local value.  You can
  287. set the local value with ":setlocal".  That buffer will then use the local
  288. value, while other buffers continue using the global value.
  289.  
  290. For example, you have two windows, both on C source code.  They use the global
  291. 'makeprg' option.  If you do this in one of the two windows: >
  292.     :set makeprg=gmake
  293. then the other window will switch to the same value.  There is no need to set
  294. the 'makeprg' option in the other C source window too.
  295. However, if you start editing a Perl file in a new window, you want to use
  296. another 'makeprog' for it, without changing the value used for the C source
  297. files.  You use this command: >
  298.     :setlocal makeprg=perlmake
  299. You can switch back to using the global value by making the local value empty: >
  300.     :setlocal makeprg=
  301. This only works for a string option.  For a boolean option you need to use the
  302. "<" flag, like this: >
  303.     :setlocal autoread<
  304. Note that for non-boolean options using "<" copies the global value to the
  305. local value, it doesn't switch back to using the global value (that matters
  306. when changing the global value later).
  307. Note: In the future more global options can be made global-local.  Using
  308. ":setlocal" on a global option might work differently then.
  309.  
  310.  
  311. Setting the filetype
  312.  
  313. :setf[iletype] {filetype}            *:setf* *:setfiletype*
  314.             Set the 'filetype' option to {filetype}, but only if
  315.             not done yet in a sequence of (nested) autocommands.
  316.             This is short for: >
  317.                 :if !did_filetype()
  318.                 :  setlocal filetype={filetype}
  319.                 :endif
  320. <            This command is used in a filetype.vim file to avoid
  321.             setting the 'filetype' option twice, causing different
  322.             settings and syntax files to be loaded.
  323.             {not in Vi}
  324.  
  325. :bro[wse] se[t]            *:set-browse* *:browse-set* *:opt* *:options*
  326. :opt[ions]        Open a window for viewing and setting all options.
  327.             Options are grouped by function.
  328.             Offers short help for each option.  Hit <CR> on the
  329.             short help to open a help window with more help for
  330.             the option.
  331.             Modify the value of the option and hit <CR> on the
  332.             "set" line to set the new value.  For window and
  333.             buffer specific options, the last accessed window is
  334.             used to set the option value in, unless this is a help
  335.             window, in which case the window below help window is
  336.             used (skipping the option-window).
  337.             {not available when compiled without the |+eval| or
  338.             |+autocmd| features}
  339.  
  340.                                 *$HOME*
  341. Using "~" is like using "$HOME", but it is only recognized at the start of an
  342. option and after a space or comma.
  343.  
  344. On Unix systems "~user" can be used too.  It is replaced by the home directory
  345. of user "user".  Example: >
  346.     :set path=~mool/include,/usr/include,.
  347.  
  348. On Unix systems the form "${HOME}" can be used too.  The name between {} can
  349. contain non-id characters then.  Note that if you want to use this for the
  350. "gf" command, you need to add the '{' and '}' characters to 'isfname'.
  351.  
  352.  
  353. Note the maximum length of an expanded option is limited.  How much depends on
  354. the system, mostly it is something like 256 or 1024 characters.
  355.  
  356.                             *:fix* *:fixdel*
  357. :fix[del]        Set the value of 't_kD':
  358.                 't_kb' is     't_kD' becomes    ~
  359.                   CTRL-?    CTRL-H
  360.                 not CTRL-?    CTRL-?
  361.  
  362.             (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
  363.  
  364.             If your delete key terminal code is wrong, but the
  365.             code for backspace is alright, you can put this in
  366.             your .vimrc: >
  367.                 :fixdel
  368. <            This works no matter what the actual code for
  369.             backspace is.
  370.  
  371.             If the backspace key terminal code is wrong you can
  372.             use this: >
  373.                 :if &term == "termname"
  374.                 :  set t_kb=^V<BS>
  375.                 :  fixdel
  376.                 :endif
  377. <            Where "^V" is CTRL-V and "<BS>" is the backspace key
  378.             (don't type four characters!).  Replace "termname"
  379.             with your terminal name.
  380.  
  381.             If your <Delete> key sends a strange key sequence (not
  382.             CTRL-? or CTRL-H) you cannot use ":fixdel".  Then use: >
  383.                 :if &term == "termname"
  384.                 :  set t_kD=^V<Delete>
  385.                 :endif
  386. <            Where "^V" is CTRL-V and "<Delete>" is the delete key
  387.             (don't type eight characters!).  Replace "termname"
  388.             with your terminal name.
  389.  
  390.                             *Linux-backspace*
  391.             Note about Linux: By default the backspace key
  392.             produces CTRL-?, which is wrong.  You can fix it by
  393.             putting this line in your rc.local: >
  394.                 echo "keycode 14 = BackSpace" | loadkeys
  395. <
  396.                             *NetBSD-backspace*
  397.             Note about NetBSD: If your backspace doesn't produce
  398.             the right code, try this this: >
  399.                 xmodmap -e "keycode 22 = BackSpace"
  400. <            If this works, add this in your .Xmodmap file: >
  401.                 keysym 22 = BackSpace
  402. <            You need to restart for this to take effect.
  403.  
  404. ==============================================================================
  405. 2. Automatically setting options            *auto-setting*
  406.  
  407. Besides changing options with the ":set" command, there are three alternatives
  408. to set options automatically for one or more files:
  409.  
  410. 1. When starting Vim initializations are read from various places.  See
  411.    |initialization|.  Most of them are performed for all editing sessions,
  412.    and some of them depend on the directory where Vim is started.
  413.    You can create an initialization file with |:mkvimrc|, |:mkview| and
  414.    |:mksession|.
  415. 2. If you start editing a new file, the automatic commands are executed.
  416.    This can be used to set options for files matching a particular pattern and
  417.    many other things.  See |autocommand|.
  418. 3. If you start editing a new file, and the 'modeline' option is on, a
  419.    number of lines at the beginning and end of the file are checked for
  420.    modelines.  This is explained here.
  421.  
  422.                         *modeline* *vim:* *vi:* *ex:*
  423. There are two forms of modelines.  The first form:
  424.     [text]{white}{vi:|vim:|ex:}[white]{options}
  425.  
  426. [text]        any text or empty
  427. {white}        at least one white space (<Space> or <Tab>)
  428. {vi:|vim:|ex:}    the string "vi:", "vim:" or "ex:"
  429. [white]        optional white space
  430. {options}    a list of option settings, separated with white space or ':',
  431.         where each part between ':' is the argument for a ":set"
  432.         command
  433.  
  434. Example: >
  435.    vi:noai:sw=3 ts=6
  436.  
  437. The second form (this is compatible with some versions of Vi):
  438.  
  439.     [text]{white}{vi:|vim:|ex:}[white]set {options}:[text]
  440.  
  441. [text]        any text or empty
  442. {white}        at least one white space (<Space> or <Tab>)
  443. {vi:|vim:|ex:}    the string "vi:", "vim:" or "ex:"
  444. [white]        optional white space
  445. set        the string "set " (note the space)
  446. {options}    a list of options, separated with white space, which is the
  447.         argument for a ":set" command
  448. :        a colon
  449. [text]        any text or empty
  450.  
  451. Example: >
  452.    /* vim: set ai tw=75: */
  453.  
  454. The white space before {vi:|vim:|ex:} is required.  This minimizes the chance
  455. that a normal word like "lex:" is caught.  There is one exception: "vi:" and
  456. "vim:" can also be at the start of the line (for compatibility with version
  457. 3.0).  Using "ex:" at the start of the line will be ignored (this could be
  458. short for "example:").
  459.  
  460.                             *modeline-local*
  461. The options are set like with ":setlocal": The new value only applies to the
  462. buffer that contains the window.  Although it's possible to set global options
  463. from a modeline, this is unusual.  If you have two windows open and the files
  464. in it set the same global option to a different value, the result depends on
  465. which one was opened last.
  466.  
  467.                             *modeline-version*
  468. If the modeline is only to be used for some versions of Vim, the version
  469. number can be specified where "vim:" is used:
  470.     vim{vers}:    version {vers} or later
  471.     vim<{vers}:    version before {vers}
  472.     vim={vers}:    version {vers}
  473.     vim>{vers}:    version after {vers}
  474. {vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
  475. For example, to use a modeline only for Vim 6.0 and later: >
  476.     /* vim600: set foldmethod=marker: */
  477. To use a modeline for Vim before version 5.7: >
  478.     /* vim<570: set sw=4: */
  479. There can be no blanks between "vim" and the ":".
  480.  
  481.  
  482. The number of lines that are checked can be set with the 'modelines' option.
  483. If 'modeline' is off or 'modelines' is 0 no lines are checked.
  484.  
  485. Note that for the first form all of the rest of the line is used, thus a line
  486. like: >
  487.    /* vi:ts=4: */
  488. will give an error message for the trailing "*/".  This line is OK: >
  489.    /* vi:set ts=4: */
  490.  
  491. If an error is detected the rest of the line is skipped.
  492.  
  493. If you want to include a ':' in a set command precede it with a '\'.  The
  494. backslash in front of the ':' will be removed.  Example: >
  495.    /* vi:set dir=c\:\tmp: */
  496. This sets the 'dir' option to "c:\tmp".  Only a single backslash before the
  497. ':' is removed.  Thus to include "\:" you have to specify "\\:".
  498.  
  499. No other commands than "set" are supported, for security reasons (somebody
  500. might create a Trojan horse text file with modelines).
  501.  
  502. Hint: If you would like to do something else than setting an option, you could
  503. define an autocommand that checks the file for a specific string.  For
  504. example: >
  505.     au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
  506. And define a function SetVar() that does something with the line containing
  507. "VAR".
  508.  
  509. ==============================================================================
  510. 3. Options summary                    *option-summary*
  511.  
  512. In the list below all the options are mentioned with their full name and with
  513. an abbreviation if there is one.  Both forms may be used.
  514.  
  515. In this document when a boolean option is "set" that means that ":set option"
  516. is entered.  When an option is "reset", ":set nooption" is used.
  517.  
  518. For some options there are two default values: The "Vim default", which is
  519. used when 'compatible' is not set, and the "Vi default", which is used when
  520. 'compatible' is set.
  521.  
  522. Most options are the same in all windows and buffers.  There are a few that
  523. are specific to how the text is presented in a window.  These can be set to a
  524. different value in each window.  For example the 'list' option can be set in
  525. one window and reset in another for the same text, giving both types of view
  526. at the same time.  There are a few options that are specific to a certain
  527. file.  These can have a different value for each file or buffer.  For example
  528. the 'textwidth' option can be 78 for a normal text file and 0 for a C
  529. program.
  530.  
  531.     global            one option for all buffers and windows
  532.     local to window        each window has its own copy of this option
  533.     local to buffer        each buffer has its own copy of this option
  534.  
  535. When creating a new window the option values from the currently active window
  536. are used as a default value for the window-specific options.  For the
  537. buffer-specific options this depends on the 's' and 'S' flags in the
  538. 'cpoptions' option.  If 's' in included (which is the default) the values for
  539. buffer options are copied from the currently active buffer when a buffer is
  540. first entered.  If 'S' is present the options are copied each time the buffer
  541. is entered, this is almost like having global options.  If 's' and 'S' are not
  542. present, the options are copied from the currently active buffer when the
  543. buffer is created.
  544.  
  545.                             *E355*
  546. A jump table for the options with a short description can be found at |Q_op|.
  547.  
  548.                     *'aleph'* *'al'* *aleph* *Aleph*
  549. 'aleph' 'al'        number    (default 128 for MS-DOS, 224 otherwise)
  550.             global
  551.             {not in Vi}
  552.             {only available when compiled with the |+rightleft|
  553.             feature}
  554.     The ASCII code for the first letter of the Hebrew alphabet.  The
  555.     routine that maps the keyboard in Hebrew mode, both in Insert mode
  556.     (when hkmap is set) and on the command-line (when hitting CTRL-_)
  557.     outputs the Hebrew characters in the range [aleph..aleph+26].
  558.     aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
  559.     See |rileft.txt|.
  560.  
  561.             *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
  562. 'allowrevins' 'ari'    boolean    (default off)
  563.             global
  564.             {not in Vi}
  565.             {only available when compiled with the |+rightleft|
  566.             feature}
  567.     Allow CTRL-_ in Insert and Command-line mode.  This is default off, to
  568.     avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
  569.     into reverse Insert mode, and don't know how to get out.  See
  570.     'revins'.
  571.     NOTE: This option is reset when 'compatible' is set.
  572.  
  573.              *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
  574. 'altkeymap' 'akm'    boolean (default off)
  575.             global
  576.             {not in Vi}
  577.             {only available when compiled with the |+farsi|
  578.             feature}
  579.     When on, the second language is Farsi. In editing mode CTRL-_ toggles
  580.     the keyboard map between Farsi and English, when 'allowrevins' set.
  581.  
  582.     When off, the keyboard map toggles between Hebrew and English. This
  583.     is useful to start the vim in native mode i.e. English (left-to-right
  584.     mode) and have default second language Farsi or Hebrew (right-to-left
  585.     mode).  See |farsi.txt|.
  586.  
  587.             *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
  588. 'autoindent' 'ai'    boolean    (default off)
  589.             local to buffer
  590.     Copy indent from current line when starting a new line (typing <CR>
  591.     in Insert mode or when using the "o" or "O" command).  If you do not
  592.     type anything on the new line except <BS> or CTRL-D and then type
  593.     <Esc> or <CR>, the indent is deleted again.  When autoindent is on,
  594.     formatting (with the "gq" command or when you reach 'textwidth' in
  595.     Insert mode) uses the indentation of the first line.
  596.     When 'smartindent' or 'cindent' is on the indent is changed in
  597.     a different way.
  598.     The 'autoindent' option is reset when the 'paste' option is set.
  599.     {small difference from Vi: After the indent is deleted when typing
  600.     <Esc> or <CR>, the cursor position when moving up or down is after the
  601.     deleted indent; Vi puts the cursor somewhere in the deleted indent}.
  602.  
  603.                  *'autoread'* *'ar'* *'noautoread'* *'noar'*
  604. 'autoread' 'ar'        boolean    (default off)
  605.             global or local to buffer |global-local|
  606.             {not in Vi}
  607.     When a file has been detected to have been changed outside of Vim and
  608.     it has not been changed inside of Vim, automatically read it again.
  609.     When the file has been deleted this is not done.  |timestamp|
  610.     If this option has a local value, use this command to switch back to
  611.     using the global value: >
  612.         :set autoread<
  613. <
  614.                  *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
  615. 'autowrite' 'aw'    boolean    (default off)
  616.             global
  617.     Write the contents of the file, if it has been modified, on each
  618.     :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
  619.     :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
  620.     '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
  621.     Note that for some commands the 'autowrite' option is not used, see
  622.     'autowriteall' for that.
  623.  
  624.              *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
  625. 'autowriteall' 'awa'    boolean    (default off)
  626.             global
  627.             {not in Vi}
  628.     Like 'autowrite', but also used for commands ":edit", ":quit",
  629.     ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
  630.     Setting this option also implies that Vim behaves like 'autowrite' has
  631.     been set.
  632.  
  633.                             *'background'* *'bg'*
  634. 'background' 'bg'    string    (default "dark" or "light")
  635.             global
  636.             {not in Vi}
  637.     When set to "dark", Vim will try to use colors that look good on a
  638.     dark background.  When set to "light", Vim will try to use colors that
  639.     look good on a light background.  Any other value is illegal.
  640.     Vim tries to set the default value according to the terminal used.
  641.     This will not always be correct.
  642.     Setting this option does not change the background color, it tells Vim
  643.     what the background color looks like.  For changing the background
  644.     color, see |:hi-normal|.
  645.  
  646.     When 'background' is set Vim will adjust the default color groups for
  647.     the new value.  But the colors used for syntax highlighting will not
  648.     change.
  649.     When a color scheme is loaded (the "colors_name" variable is set)
  650.     setting 'background' will cause the color scheme to be reloaded.  If
  651.     the color scheme adjusts to the value of 'background' this will work.
  652.     However, if the color scheme sets 'background' itself the effect may
  653.     be undone.  First delete the "colors_name" variable when needed.
  654.  
  655.     When setting 'background' to the default value with: >
  656.         :set background&
  657. <    Vim will guess the value.  In the GUI this should work correctly,
  658.     in other cases Vim might not be able to guess the right value.
  659.  
  660.     When starting the GUI, the default value for 'background' will be
  661.     "light".  When the value is not set in the .gvimrc, and Vim detects
  662.     that the background is actually quite dark, 'background' is set to
  663.     "dark".  But this happens only AFTER the .gvimrc file has been read
  664.     (because the window needs to be opened to find the actual background
  665.     color).  To get around this, force the GUI window to be opened by
  666.     putting a ":gui" command in the .gvimrc file, before where the value
  667.     of 'background' is used (e.g., before ":syntax on").
  668.     For the Win32 GUI, setting 'background' before starting the GUI, will
  669.     change the background and foreground colors to lightgrey on black or
  670.     black on white.  On other systems setting 'background' does not
  671.     change the foreground or background colors.
  672.     Normally this option would be set in the .vimrc file.  Possibly
  673.     depending on the terminal name.  Example: >
  674.         :if &term == "pcterm"
  675.         :  set background=dark
  676.         :endif
  677. <    When this option is set, the default settings for the highlight groups
  678.     will change.  To use other settings, place ":highlight" commands AFTER
  679.     the setting of the 'background' option.
  680.     This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
  681.     to select the colors for syntax highlighting.  After changing this
  682.     option, you must load syntax.vim again to see the result.  This can be
  683.     done with ":syntax on".
  684.  
  685.                             *'backspace'* *'bs'*
  686. 'backspace' 'bs'    string    (default "")
  687.             global
  688.             {not in Vi}
  689.     Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
  690.     mode.  This is a list of items, separated by commas.  Each item allows
  691.     a way to backspace over something:
  692.     value    effect  ~
  693.     indent  allow backspacing over autoindent
  694.     eol    allow backspacing over line breaks (join lines)
  695.     start    allow backspacing over the start of insert; CTRL-W and CTRL-U
  696.         stop once at the start of insert.
  697.  
  698.     When the value is empty, Vi compatible backspacing is used.
  699.  
  700.     For backwards compatibility with version 5.4 and earlier:
  701.     value    effect  ~
  702.       0    same as "" (Vi compatible)
  703.       1    same as "indent,eol"
  704.       2    same as "indent,eol,start"
  705.  
  706.     See |:fixdel| if your <BS> or <Del> key does not do what you want.
  707.     NOTE: This option is set to "" when 'compatible' is set.
  708.  
  709.                 *'backup'* *'bk'* *'nobackup'* *'nobk'*
  710. 'backup' 'bk'        boolean    (default off)
  711.             global
  712.             {not in Vi}
  713.     Make a backup before overwriting a file.  Leave it around after the
  714.     file has been successfully written.  If you do not want to keep the
  715.     backup file, but you do want a backup while the file is being
  716.     written, reset this option and set the 'writebackup' option (this is
  717.     the default).  If you do not want a backup file at all reset both
  718.     options (use this if your file system is almost full).  See the
  719.     |backup-table| for more explanations.
  720.     When the 'backupskip' pattern matches, a backup is not made anyway.
  721.     When 'patchmode' is set, the backup may be renamed to become the
  722.     oldest version of a file.
  723.     NOTE: This option is reset when 'compatible' is set.
  724.  
  725.                         *'backupcopy'* *'bkc'*
  726. 'backupcopy' 'bkc'    string    (Vi default for Unix: "yes", otherwise: "auto")
  727.             global
  728.             {not in Vi}
  729.     When writing a file and a backup is made, this option tells how it's
  730.     done:
  731.     "yes"    make a copy of the file and overwrite the original one
  732.     "no"    rename the file and write a new one
  733.     "auto"    one of the previous, what works best
  734.  
  735.     Making a copy and overwriting the original file:
  736.     - Takes extra time to copy the file.
  737.     + When the file has special attributes, is a (hard/symbolic) link or
  738.       has a resource fork, all this is preserved.
  739.     - When the file is a link the backup will have the name of the link,
  740.       not of the real file.
  741.  
  742.     Renaming the file and writing a new one:
  743.     + It's fast.
  744.     - Sometimes not all attributes of the file can be copied to the new
  745.       file.
  746.     - When the file is a link the new file will not be a link.
  747.  
  748.     The "auto" value is the middle way: When Vim sees that renaming file
  749.     is possible without side effects (the attributes can be passed on and
  750.     and the file is not a link) that is used.  When problems are expected,
  751.     a copy will be made.
  752.  
  753.     One situation where "no" and "auto" will cause problems: A program
  754.     that opens a file, invokes Vim to edit that file, and then tests if
  755.     the open file was changed (through the file descriptor) will check the
  756.     backup file instead of the newly created file.  "crontab -e" is an
  757.     example.
  758.  
  759.     When a copy is made, the original file is truncated and then filled
  760.     with the new text.  This means that protection bits, owner and
  761.     symbolic links of the original file are unmodified.  The backup file
  762.     however, is a new file, owned by the user who edited the file.  The
  763.     group of the backup is set to the group of the original file.  If this
  764.     fails, the protection bits for the group are made the same as for
  765.     others.
  766.  
  767.     When the file is renamed this is the other way around: The backup has
  768.     the same attributes of the original file, and the newly written file
  769.     is owned by the current user.  When the file was a (hard/symbolic)
  770.     link, the new file will not!  That's why the "auto" value doesn't
  771.     rename when the file is a link.  The owner and group of the newly
  772.     written file will be set to the same ones as the original file, but
  773.     the system may refuse to do this.  In that case the "auto" value will
  774.     again not rename the file.
  775.  
  776.                         *'backupdir'* *'bdir'*
  777. 'backupdir' 'bdir'    string    (default for Amiga: ".,t:",
  778.                  for MS-DOS and Win32: ".,c:/tmp,c:/temp"
  779.                  for Unix: ".,~/tmp,~/")
  780.             global
  781.             {not in Vi}
  782.     List of directories for the backup file, separated with commas.
  783.     - The backup file will be created in the first directory in the list
  784.       where this is possible.
  785.     - Empty means that no backup file will be created ('patchmode' is
  786.       impossible!).
  787.     - A directory "." means to put the backup file in the same directory
  788.       as the edited file.
  789.     - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
  790.       put the backup file relative to where the edited file is.  The
  791.       leading "." is replaced with the path name of the edited file.
  792.       ("." inside a directory name has no special meaning).
  793.     - Spaces after the comma are ignored, other spaces are considered part
  794.       of the directory name.  To have a space at the start of a directory
  795.       name, precede it with a backslash.
  796.     - To include a comma in a directory name precede it with a backslash.
  797.     - A directory name may end in an '/'.
  798.     - Environment variables are expanded |:set_env|.
  799.     - Careful with '\' characters, type one before a space, type two to
  800.       get one in the option (see |option-backslash|), for example: >
  801.         :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  802. <    - For backwards compatibility with Vim version 3.0 a '>' at the start
  803.       of the option is removed.
  804.     See also 'backup' and 'writebackup' options.
  805.     If you want to hide your backup files on Unix, consider this value: >
  806.         :set backupdir=./.backup,~/.backup,.,/tmp
  807. <    You must create a ".backup" directory in each directory and in your
  808.     home directory for this to work properly.
  809.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  810.     directories from the list.  This avoids problems when a future version
  811.     uses another default.
  812.     This option cannot be set from a |modeline|, for security reasons.
  813.  
  814.                         *'backupext'* *'bex'*
  815. 'backupext' 'bex'    string    (default "~", for VMS: "_")
  816.             global
  817.             {not in Vi}
  818.     String which is appended to a file name to make the name of the
  819.     backup file.  The default is quite unusual, because this avoids
  820.     accidentally overwriting existing files with a backup file.  You might
  821.     prefer using ".bak", but make sure that you don't have files with
  822.     ".bak" that you want to keep.
  823.  
  824.                         *'backupskip'* *'bsk'*
  825. 'backupskip' 'bsk'    string  (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
  826.             global
  827.             {not in Vi}
  828.             {not available when compiled without the |+wildignore|
  829.             feature}
  830.     A list of file patterns.  When one of the patterns matches with the
  831.     name of the file which is written, no backup file is created.  Both
  832.     the specified file name and the full path name of the file are used.
  833.     The pattern is used like with |:autocmd|, see |autocmd-patterns|.
  834.     Watch out for special characters, see |option-backslash|.
  835.     When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
  836.     default value. "/tmp/*" is only used for Unix.
  837.  
  838.                         *'balloondelay'* *'bdlay'*
  839. 'balloondelay' 'bdlay'    number    (default: 600)
  840.             global
  841.             {not in Vi}
  842.             {only available when compiled with the |+balloon_eval|
  843.             feature}
  844.     Delay in milliseconds before a balloon may pop up.  See |balloon-eval|.
  845.  
  846.                *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
  847. 'ballooneval' 'beval'    boolean    (default off)
  848.             global
  849.             {not in Vi}
  850.             {only available when compiled with the |+balloon_eval|
  851.             and |+sun_workshop| features}
  852.     Switch on the |balloon-eval| functionality.
  853.  
  854.                      *'binary'* *'bin'* *'nobinary'* *'nobin'*
  855. 'binary' 'bin'        boolean    (default off)
  856.             local to buffer
  857.             {not in Vi}
  858.     This option should be set before editing a binary file.  You can also
  859.     use the "-b" Vim argument.  When this option is switched on a few
  860.     options will be changed (also when it already was on):
  861.         'textwidth'  will be set to 0
  862.         'wrapmargin' will be set to 0
  863.         'modeline'   will be off
  864.         'expandtab'  will be off
  865.     Also, 'fileformat' and 'fileformats' options will not be used, the
  866.     file is read and written like 'fileformat' was "unix" (a single <NL>
  867.     separates lines).
  868.     The 'fileencoding' and 'fileencodings' options will not be used, the
  869.     file is read without conversion.
  870.     NOTE: When you start editing a(nother) file while the 'bin' option is
  871.     on, settings from autocommands may change the settings again (e.g.,
  872.     'textwidth'), causing trouble when editing.  You might want to set
  873.     'bin' again when the file has been loaded.
  874.     The previous values of these options are remembered and restored when
  875.     'bin' is switched from on to off.  Each buffer has its own set of
  876.     saved option values.
  877.     When writing a file the <EOL> for the last line is only written if
  878.     there was one in the original file (normally Vim appends an <EOL> to
  879.     the last line if there is none; this would make the file longer).  See
  880.     the 'endofline' option.
  881.  
  882.             *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
  883. 'bioskey' 'biosk'    boolean    (default on)
  884.             global
  885.             {not in Vi}  {only for MS-DOS}
  886.     When on the bios is called to obtain a keyboard character.  This works
  887.     better to detect CTRL-C, but only works for the console.  When using a
  888.     terminal over a serial port reset this option.
  889.     Also see |'conskey'|.
  890.  
  891.                             *'bomb'* *'nobomb'*
  892. 'bomb'            boolean    (default off)
  893.             local to buffer
  894.             {not in Vi}
  895.             {only available when compiled with the |+multi_byte|
  896.             feature}
  897.     When writing a file and the following conditions are met, a BOM (Byte
  898.     Order Mark) is prepended to the file:
  899.     - this option is on
  900.     - the 'binary' option is off
  901.     - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
  902.       endian variants.
  903.     Some applications use the BOM to recognize the encoding of the file.
  904.     Often used for UCS-2 files on MS-Windows.  For other applications it
  905.     causes trouble, for example: "cat file1 file2" makes the BOM of file2
  906.     appear halfway the file.
  907.     When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
  908.     check for the presence of the BOM is done and 'bomb' set accordingly.
  909.     Unless 'binary' is set, it is removed from the first line, so that you
  910.     don't see it when editing.  When you don't change the options, the BOM
  911.     will be restored when writing the file.
  912.  
  913.                         *'breakat'* *'brk'*
  914. 'breakat' 'brk'        string    (default " ^I!@*-+;:,./?")
  915.             global
  916.             {not in Vi}
  917.             {not available when compiled without the  |+linebreak|
  918.             feature}
  919.     This option lets you choose which characters might cause a line
  920.     break if 'linebreak' is on.
  921.  
  922.                         *'browsedir'* *'bsdir'*
  923. 'browsedir' 'bsdir'    string    (default for "last")
  924.             global
  925.             {not in Vi} {only for Motif and Win32 GUI}
  926.     Which directory to use for the file browser:
  927.        last        Use same directory as with last file browser.
  928.        buffer    Use the directory of the related buffer.
  929.        current    Use the current directory.
  930.        {path}    Use the specified directory
  931.  
  932.                         *'bufhidden'* *'bh'*
  933. 'bufhidden' 'bh'    string (default: "")
  934.             local to buffer
  935.             {not in Vi}
  936.             {not available when compiled without the |+quickfix|
  937.             feature}
  938.     This option specifies what happens when a buffer is no longer
  939.     displayed in a window:
  940.       <empty>    follow the global 'hidden' option
  941.       hide        hide the buffer (don't unload it), also when 'hidden'
  942.             is not set
  943.       unload    unload the buffer, also when 'hidden' is set or using
  944.             |:hide|
  945.       delete    delete the buffer from the buffer list, also when
  946.             'hidden' is set or using |:hide|, like using
  947.             |:bdelete|
  948.  
  949.     This option is used together with 'buftype' and 'swapfile' to specify
  950.     special kinds of buffers.   See |special-buffers|.
  951.  
  952.                         *'buflisted'* *'bl'* *E85*
  953. 'buflisted' 'bl'    boolean (default: on)
  954.             local to buffer
  955.             {not in Vi}
  956.     When this option is set, the buffer shows up in the buffer list.  If
  957.     it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
  958.     This option is reset by Vim for buffers that are only used to remember
  959.     a file name or marks.  Vim sets it when starting to edit a buffer.
  960.     But not when moving to a buffer with ":buffer".
  961.  
  962.                         *'buftype'* *'bt'* *E382*
  963. 'buftype' 'bt'        string (default: "")
  964.             local to buffer
  965.             {not in Vi}
  966.             {not available when compiled without the |+quickfix|
  967.             feature}
  968.     The value of this option specifies the type of a buffer:
  969.       <empty>    normal buffer
  970.       nofile    buffer which is not related to a file and will not be
  971.             written
  972.       nowrite    buffer which will not be written
  973.       quickfix    quickfix buffer, contains list of errors |:cwindow|
  974.       help        help buffer (you are not supposed to set this
  975.             manually)
  976.  
  977.     This option is used together with 'bufhidden' and 'swapfile' to
  978.     specify special kinds of buffers.   See |special-buffers|.
  979.  
  980.     Be careful with changing this option, it can have many side effects!
  981.  
  982.     A "quickfix" buffer is only used for the error list.  This value is
  983.     set by the |:cwindow| command and you are not supposed to change it.
  984.  
  985.     "nofile" and "nowrite" buffers are similar:
  986.     both:        The buffer is not to be written to disk, ":w" doesn't
  987.             work (":w filename" does work though).
  988.     both:        The buffer is never considered to be |'modified'|.
  989.             There is no warning when the changes will be lost, for
  990.             example when you quit Vim.
  991.     both:        A swap file is only created when using too much memory
  992.             (when 'swapfile' has been reset there is never a swap
  993.             file).
  994.     nofile only:    The buffer name is fixed, it is not handled like a
  995.             file name.  It is not modified in response to a |:cd|
  996.             command.
  997.  
  998.                         *'cdpath'* *'cd'* *E344* *E346*
  999. 'cdpath' 'cd'        string    (default: equivalent to $CDPATH or ",,")
  1000.             global
  1001.             {not in Vi}
  1002.             {not available when compiled without the
  1003.             |+file_in_path| feature}
  1004.     This is a list of directories which will be searched when using the
  1005.     |:cd| and |:lcd| commands, provided that the directory being searched
  1006.     for has a relative path (not starting with "/", "./" or "../").
  1007.     The 'cdpath' option's value has the same form and semantics as
  1008.     |'path'|.  Also see |file-searching|.
  1009.     The default value is taken from $CDPATH, with a "," prepended to look
  1010.     in the current directory first.
  1011.     If the default value taken from $CDPATH is not what you want, include
  1012.     a modified version of the following command in your vimrc file to
  1013.     override it: >
  1014.       :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
  1015. <    This option cannot be set from a |modeline|, for security reasons
  1016.     (parts of 'cdpath' can be passed to the shell to expand file names).
  1017.  
  1018.                         *'cedit'*
  1019. 'cedit'            string    (Vi default: "", Vim default: CTRL-F)
  1020.             global
  1021.             {not in Vi}
  1022.             {not available when compiled without the |+vertsplit|
  1023.             feature}
  1024.     The key used in Command-line Mode to open the command-line window.
  1025.     The default is CTRL-F when 'compatible' is off.
  1026.     Only non-printable keys are allowed.
  1027.     The key can be specified as a single character, but it is difficult to
  1028.     type.  The preferred way is to use the <> notation.  Examples: >
  1029.         :set cedit=<C-Y>
  1030.         :set cedit=<Esc>
  1031. <    |Nvi| also has this option, but it only uses the first character.
  1032.     See |cmdwin|.
  1033.  
  1034.                     *'charconvert'* *'ccv'* *E202* *E214*
  1035. 'charconvert' 'ccv'    string (default "")
  1036.             global
  1037.             {only available when compiled with the |+multi_byte|
  1038.             feature and the |+eval| feature}
  1039.             {not in Vi}
  1040.     An expression that is used for character encoding conversion.  It is
  1041.     evaluated when a file that is to be read or has been written has a
  1042.     different encoding from what is desired.
  1043.     'charconvert' is not used when the internal iconv() function is
  1044.     supported and is able to do the conversion.  Using iconv() is
  1045.     preferred, because it is much faster.
  1046.     'charconvert' is not used when reading stdin |--|, because there is no
  1047.     file to convert from.  You will have to save the text in a file first.
  1048.     The expression must return zero or an empty string for success,
  1049.     non-zero for failure.
  1050.     The possible encoding names encountered are in 'encoding'.
  1051.     Additionally, names given in 'fileencodings' and 'fileencoding' are
  1052.     used.
  1053.     Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
  1054.     is done internally by Vim, 'charconvert' is not used for this.
  1055.     'charconvert' is also used to convert the viminfo file, if the 'c'
  1056.     flag is present in 'viminfo'.  Also used for Unicode conversion.
  1057.     Example: >
  1058.         set charconvert=CharConvert()
  1059.         fun CharConvert()
  1060.           system("recode "
  1061.             \ . v:charconvert_from . ".." . v:charconvert_to
  1062.             \ . " <" . v:fname_in . " >" v:fname_out)
  1063.           return v:shell_error
  1064.         endfun
  1065. <    The related Vim variables are:
  1066.         v:charconvert_from    name of the current encoding
  1067.         v:charconvert_to    name of the desired encoding
  1068.         v:fname_in        name of the input file
  1069.         v:fname_out        name of the output file
  1070.     Note that v:fname_in and v:fname_out will never be the same.
  1071.     Note that v:charconvert_from and v:charconvert_to may be different
  1072.     from 'encoding'.  Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
  1073.     Encryption is not done by Vim when using 'charconvert'.  If you want
  1074.     to encrypt the file after conversion, 'charconvert' should take care
  1075.     of this.
  1076.     This option cannot be set from a |modeline|, for security reasons.
  1077.  
  1078.                    *'cindent'* *'cin'* *'nocindent'* *'nocin'*
  1079. 'cindent' 'cin'        boolean    (default off)
  1080.             local to buffer
  1081.             {not in Vi}
  1082.             {not available when compiled without the |+cindent|
  1083.             feature}
  1084.     Enables automatic C program indenting  See 'cinkeys' to set the keys
  1085.     that trigger reindenting in insert mode and 'cinoptions' to set your
  1086.     preferred indent style.
  1087.     If 'indentexpr' is not empty, it overrules 'cindent'.
  1088.     If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
  1089.     the "=" operator indents using this algorithm rather than calling an
  1090.     external program.
  1091.     See |C-indenting|.
  1092.     When you don't like the way 'cindent' works, try the 'smartindent'
  1093.     option or 'indentexpr'.
  1094.     This option is not used when 'paste' is set.
  1095.     NOTE: This option is reset when 'compatible' is set.
  1096.  
  1097.                             *'cinkeys'* *'cink'*
  1098. 'cinkeys' 'cink'    string    (default "0{,0},0),:,0#,!^F,o,O,e")
  1099.             local to buffer
  1100.             {not in Vi}
  1101.             {not available when compiled without the |+cindent|
  1102.             feature}
  1103.     A list of keys that, when typed in Insert mode, cause reindenting of
  1104.     the current line.  Only used if 'cindent' is on and 'indentexpr' is
  1105.     empty.
  1106.     For the format of this option see |cinkeys-format|.
  1107.     See |C-indenting|.
  1108.  
  1109.                         *'cinoptions'* *'cino'*
  1110. 'cinoptions' 'cino'    string    (default "")
  1111.             local to buffer
  1112.             {not in Vi}
  1113.             {not available when compiled without the |+cindent|
  1114.             feature}
  1115.     The 'cinoptions' affect the way 'cindent' reindents lines in a C
  1116.     program.  See |cinoptions-values| for the values of this option, and
  1117.     |C-indenting| for info on C indenting in general.
  1118.  
  1119.  
  1120.                         *'cinwords'* *'cinw'*
  1121. 'cinwords' 'cinw'    string    (default "if,else,while,do,for,switch")
  1122.             local to buffer
  1123.             {not in Vi}
  1124.             {not available when compiled without both the
  1125.             |+cindent| and the |+smartindent| features}
  1126.     These keywords start an extra indent in the next line when
  1127.     'smartindent' or 'cindent' is set.  For 'cindent' this is only done at
  1128.     an appropriate place (inside {}).
  1129.     Note that 'ignorecase' isn't used for 'cinwords'.  If case doesn't
  1130.     matter, include the keyword both the uppercase and lowercase:
  1131.     "if,If,IF".
  1132.  
  1133.                         *'clipboard'* *'cb'*
  1134. 'clipboard' 'cb'    string    (default "autoselect,exclude:cons\|linux"
  1135.                           for X-windows, "" otherwise)
  1136.             global
  1137.             {not in Vi}
  1138.             {only in GUI versions or when the |+xterm_clipboard|
  1139.             feature is included}
  1140.     This option is a list of comma separated names.
  1141.     These names are recognized:
  1142.  
  1143.     unnamed        When included, Vim will use the clipboard register '*'
  1144.             for all yank, delete, change and put operations which
  1145.             would normally go to the unnamed register.  When a
  1146.             register is explicitly specified, it will always be
  1147.             used regardless of whether "unnamed" is in 'clipboard'
  1148.             or not.  The clipboard register can always be
  1149.             explicitly accessed using the "* notation.  Also see
  1150.             |gui-clipboard|.
  1151.  
  1152.     autoselect    Works like the 'a' flag in 'guioptions': If present,
  1153.             then whenever Visual mode is started, or the Visual
  1154.             area extended, Vim tries to become the owner of the
  1155.             windowing system's global selection or put the
  1156.             selected text on the clipboard used by the selection
  1157.             register "*.  See |guioptions_a| and |quotestar| for
  1158.             details.  When the GUI is active, the 'a' flag in
  1159.             'guioptions' is used, when the GUI is not active, this
  1160.             "autoselect" flag is used.
  1161.             Also applies to the modeless selection.
  1162.  
  1163.     autoselectml    Like "autoselect", but for the modeless selection
  1164.             only.  Compare to the 'A' flag in 'guioptions'.
  1165.  
  1166.     exclude:{pattern}
  1167.             Defines a pattern that is matched against the name of
  1168.             the terminal 'term'.  If there is a match, no
  1169.             connection will be made to the X server.  This is
  1170.             useful in this situation:
  1171.             - Running Vim in a console.
  1172.             - $DISPLAY is set to start applications on another
  1173.               display.
  1174.             - The X server might be terminated while Vim in the
  1175.               console is still running, killing Vim.
  1176.             To never connect to the X server use: >
  1177.                 exclude:.*
  1178. <            This has the same effect as using the |-X| argument.
  1179.             Note that the window title won't be restored as a side
  1180.             effect.
  1181.             The value of 'magic' is ignored, {pattern} is
  1182.             interpreted as if 'magic' was on.
  1183.             The rest of the option value will be used for
  1184.             {pattern}, this must be the last entry.
  1185.  
  1186.                         *'cmdheight'* *'ch'*
  1187. 'cmdheight' 'ch'    number    (default 1)
  1188.             global
  1189.             {not in Vi}
  1190.     Number of screen lines to use for the command-line.  Helps avoiding
  1191.     |hit-enter| prompts.
  1192.  
  1193.                         *'cmdwinheight'* *'cwh'*
  1194. 'cmdwinheight' 'cwh'    number    (default 7)
  1195.             global
  1196.             {not in Vi}
  1197.             {not available when compiled without the |+vertsplit|
  1198.             feature}
  1199.     Number of screen lines to use for the command-line window. |cmdwin|
  1200.  
  1201.                         *'columns'* *'co'*
  1202. 'columns' 'co'        number    (default 80 or terminal width)
  1203.             global
  1204.             {not in Vi}
  1205.     Number of columns of the screen.  Normally this is set by the terminal
  1206.     initialization and does not have to be set by hand.
  1207.     When Vim is running in the GUI or in a resizable window, setting this
  1208.     option may cause the window size to be changed.
  1209.     When you set this option and Vim is unable to change the physical
  1210.     number of columns of the display, the display may be messed up.
  1211.  
  1212.                         *'comments'* *'com'*
  1213. 'comments' 'com'    string    (default
  1214.                 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
  1215.             local to buffer
  1216.             {not in Vi}
  1217.             {not available when compiled without the |+comments|
  1218.             feature}
  1219.     A comma separated list of strings that can start a comment line.  See
  1220.     |format-comments|.  See |option-backslash| about using backslashes to
  1221.     insert a space.
  1222.  
  1223.                         *'commentstring'* *'cms'* *E221*
  1224. 'commentstring' 'cms'    string    (default "/*%s*/")
  1225.             local to buffer
  1226.             {not in Vi}
  1227.             {not available when compiled without the |+folding|
  1228.             feature}
  1229.     A template for a comment.  The "%s" in the value is replaced with the
  1230.     comment text.  Currently only used to add markers for folding, see
  1231.     |fold-marker|.
  1232.  
  1233.             *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
  1234. 'compatible' 'cp'    boolean    (default on, off when a .vimrc file is found)
  1235.             global
  1236.             {not in Vi}
  1237.     This option has the effect of making Vim either more Vi-compatible, or
  1238.     make Vim behave in a more useful way.
  1239.     This is a special kind of option, because when it's set or reset,
  1240.     other options are also changed as a side effect.  CAREFUL: Setting or
  1241.     resetting this option can have a lot of unexpected effects: Mappings
  1242.     are interpreted in another way, undo behaves differently, etc.  If you
  1243.     set this option in your vimrc file, you should probably put it at the
  1244.     very start.
  1245.     By default this option is on and the Vi defaults are used for the
  1246.     options.  This default was chosen for those people who want to use Vim
  1247.     just like Vi, and don't even (want to) know about the 'compatible'
  1248.     option.
  1249.     When a ".vimrc" file is found while Vim is starting up, this option is
  1250.     switched off, and all options that have not been modified will be set
  1251.     to the Vim defaults.  Effectively, this means that when a ".vimrc"
  1252.     file exists, Vim will use the Vim defaults, otherwise it will use the
  1253.     Vi defaults.  (Note: This doesn't happen for the system-wide vimrc
  1254.     file).  Also see |compatible-default|.
  1255.     You can also set this option with the "-C" argument, and reset it with
  1256.     "-N".  See |-C| and |-N|.
  1257.     Switching this option off makes the Vim defaults be used for options
  1258.     that have a different Vi and Vim default value.  See the options
  1259.     marked with a '+' below.  Other options are not modified.
  1260.     At the moment this option is set, several other options will be set
  1261.     or reset to make Vim as Vi-compatible as possible.  See the table
  1262.     below.  This can be used if you want to revert to Vi compatible
  1263.     editing.
  1264.     See also 'cpoptions'.
  1265.  
  1266.     option        + set value    effect    ~
  1267.  
  1268.     'allowrevins'      off        no CTRL-_ command
  1269.     'backupcopy'      Unix: "yes"      backup file is a copy
  1270.               others: "auto"  copy or rename backup file
  1271.     'backspace'      ""        normal backspace
  1272.     'backup'      off        no backup file
  1273.     'cindent'      off        no C code indentation
  1274.     'cedit'        + ""        no key to open the |cmdwin|
  1275.     'cpoptions'    + (all flags)    Vi-compatible flags
  1276.     'cscopetag'      off        don't use cscope for ":tag"
  1277.     'cscopetagorder'  0        see |cscopetagorder|
  1278.     'cscopeverbose'      off        see |cscopeverbose|
  1279.     'digraph'      off        no digraphs
  1280.     'esckeys'    + off        no <Esc>-keys in Insert mode
  1281.     'expandtab'      off        tabs not expanded to spaces
  1282.     'fileformats'    + ""        no automatic file format detection,
  1283.               "dos,unix"    except for DOS, Windows and OS/2
  1284.     'formatoptions'    + "vt"        Vi compatible formatting
  1285.     'gdefault'      off        no default 'g' flag for ":s"
  1286.     'history'    + 0        no commandline history
  1287.     'hkmap'          off        no Hebrew keyboard mapping
  1288.     'hkmapp'      off        no phonetic Hebrew keyboard mapping
  1289.     'hlsearch'      off        no highlighting of search matches
  1290.     'incsearch'      off        no incremental searching
  1291.     'indentexpr'      ""        no indenting by expression
  1292.     'insertmode'      off        do not start in Insert mode
  1293.     'iskeyword'    + "@,48-57,_"    keywords contain alphanumeric
  1294.                         characters and '_'
  1295.     'joinspaces'      on        insert 2 spaces after period
  1296.     'modeline'    + off        no modelines
  1297.     'more'        + off        no pauses in listings
  1298.     'revins'      off        no reverse insert
  1299.     'ruler'          off        no ruler
  1300.     'scrolljump'      1        no jump scroll
  1301.     'scrolloff'      0        no scroll offset
  1302.     'shiftround'      off        indent not rounded to shiftwidth
  1303.     'shortmess'    + ""        no shortening of messages
  1304.     'showcmd'    + off        command characters not shown
  1305.     'showmode'    + off        current mode not shown
  1306.     'smartcase'      off        no automatic ignore case switch
  1307.     'smartindent'      off        no smart indentation
  1308.     'smarttab'      off        no smart tab size
  1309.     'softtabstop'      0        tabs are always 'tabstop' positions
  1310.     'startofline'      on        goto startofline with some commands
  1311.     'tagrelative'    + off        tag file names are not relative
  1312.     'textauto'    + off        no automatic textmode detection
  1313.     'textwidth'      0        no automatic line wrap
  1314.     'tildeop'      off        tilde is not an operator
  1315.     'ttimeout'      off        no terminal timeout
  1316.     'whichwrap'    + ""        left-right movements don't wrap
  1317.     'wildchar'    + CTRL-E    only when the current value is <Tab>
  1318.                     use CTRL-E for cmdline completion
  1319.     'writebackup'      on or off    depends on +writebackup feature
  1320.  
  1321.                         *'complete'* *'cpt'*
  1322. 'complete' 'cpt'    string    (default: ".,w,b,u,t,i")
  1323.             local to buffer
  1324.             {not in Vi}
  1325.     This option specifies how keyword completion |ins-completion| works
  1326.     when CTRL-P or CTRL-N are used.  It is also used for whole-line
  1327.     completion |i_CTRL-X_CTRL-L|.  It indicates the type of completion
  1328.     and the places to scan.  It is a comma separated list of flags:
  1329.     .    scan the current buffer ('wrapscan' is ignored)
  1330.     w    scan buffers from other windows
  1331.     b    scan other loaded buffers that are in the buffer list
  1332.     u    scan the unloaded buffers that are in the buffer list
  1333.     U    scan the buffers that are not in the buffer list
  1334.     k    scan the files given with the 'dictionary' option
  1335.     k{dict}    scan the file {dict}.  Several "k" flags can be given,
  1336.         patterns are valid too.  For example: >
  1337.             :set cpt=k/usr/dict/*,k~/spanish
  1338. <    s    scan the files given with the 'thesaurus' option
  1339.     s{tsr}    scan the file {tsr}.  Several "s" flags can be given, patterns
  1340.         are valid too.
  1341.     i    scan current and included files
  1342.     d    scan current and included files for defined name or macro
  1343.         |i_CTRL-X_CTRL-D|
  1344.     ]    tag completion
  1345.     t    same as "]"
  1346.  
  1347.     Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
  1348.     not executed, this may lead to unexpected completions from some files
  1349.     (gzipped files for example).  Unloaded buffers are not scanned for
  1350.     whole-line completion.
  1351.  
  1352.     The default is ".,w,b,u,t,i", which means to scan:
  1353.        1. the current buffer
  1354.        2. buffers in other windows
  1355.        3. other loaded buffers
  1356.        4. unloaded buffers
  1357.        5. tags
  1358.        6. included files
  1359.  
  1360.     As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
  1361.     based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
  1362.     |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
  1363.  
  1364.                 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
  1365. 'confirm' 'cf'        boolean (default off)
  1366.             global
  1367.             {not in Vi}
  1368.     When 'confirm' is on, certain operations that would normally
  1369.     fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
  1370.     instead raise a |dialog| asking if you wish to save the current
  1371.     file(s).  You can still use a ! to unconditionally |abandon| a buffer.
  1372.     If 'confirm' is off you can still activate confirmation for one
  1373.     command only (this is most useful in mappings) with the |:confirm|
  1374.     command.
  1375.     Also see the |confirm()| function and the 'v' flag in 'guioptions'.
  1376.  
  1377.             *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
  1378. 'conskey' 'consk'    boolean    (default off)
  1379.             global
  1380.             {not in Vi}  {only for MS-DOS}
  1381.     When on direct console I/O is used to obtain a keyboard character.
  1382.     This should work in most cases.  Also see |'bioskey'|.  Together,
  1383.     three methods of console input are available:
  1384.     'conskey'   'bioskey'        action ~
  1385.        on         on or off        direct console input
  1386.        off        on        BIOS
  1387.        off        off        STDIN
  1388.  
  1389.                         *'cpoptions'* *'cpo'*
  1390. 'cpoptions' 'cpo'    string    (Vim default: "aABceFs",
  1391.                  Vi default:  all flags)
  1392.             global
  1393.             {not in Vi}
  1394.     A sequence of single character flags.  When a character is present
  1395.     this indicates vi-compatible behavior.  This is used for things where
  1396.     not being vi-compatible is mostly or sometimes preferred.
  1397.     'cpoptions' stands for "compatible-options".
  1398.     Commas can be added for readability.
  1399.     To avoid problems with flags that are added in the future, use the
  1400.     "+=" and "-=" feature of ":set" |add-option-flags|.
  1401.     NOTE: This option is set to the Vi default value when 'compatible' is
  1402.     set and to the Vim default value when 'compatible' is reset.
  1403.  
  1404.         contains    behavior    ~
  1405.         a    When included, a ":read" command with a file name
  1406.             argument will set the alternate file name for the
  1407.             current window.
  1408.         A    When included, a ":write" command with a file name
  1409.             argument will set the alternate file name for the
  1410.             current window.
  1411.         b    "\|" in a ":map" command is recognized as the end of
  1412.             the map command.  The '\' is included in the mapping,
  1413.             the text after the '|' is interpreted as the next
  1414.             command.  Use a CTRL-V instead of a backslash to
  1415.             include the '|' in the mapping.  Applies to all
  1416.             mapping, abbreviation, menu and autocmd commands.
  1417.             See also |map_bar|.
  1418.         B    A backslash has no special meaning in mappings,
  1419.             abbreviations and the "to" part of the menu commands.
  1420.             Remove this flag to be able to use a backslash like a
  1421.             CTRL-V.  For example, the command ":map X \<Esc>"
  1422.             results in X being mapped to:
  1423.                 'B' included:    "\^["    (^[ is a real <Esc>)
  1424.                 'B' excluded:   "<Esc>"  (5 characters)
  1425.                 ('<' excluded in both cases)
  1426.         C    Do not concatenate sourced lines that start with a
  1427.             backslash.  See |line-continuation|.
  1428.         c    Searching continues at the end of any match at the
  1429.             cursor position.  When not present searching continues
  1430.             one character from the cursor position.  With 'c'
  1431.             "abababababab" only gets three matches when repeating
  1432.             "/abab", without 'c' there are five matches.
  1433.         d    Using "./" in the 'tags' option doesn't mean to use
  1434.             the tags file relative to the current file, but the
  1435.             tags file in the current directory.
  1436.         D    Can't use CTRL-K to enter a digraph after Normal mode
  1437.             commands with a character argument, like |r|, |f| and
  1438.             |t|.
  1439.         e    When executing a register with ":@r", always add a
  1440.             <CR> to the last line, also when the register is not
  1441.             linewise.  If this flag is not present, the register
  1442.             is not linewise and the last line does not end in a
  1443.             <CR>, then the last line is put on the command-line
  1444.             and can be edited before hitting <CR>.
  1445.         E    It is an error when using "y", "d", "c", "g~", "gu" or
  1446.             "gU" on an Empty region.  The operators only work when
  1447.             at least one character is to be operate on.  Example:
  1448.             This makes "y0" fail in the first column.
  1449.         f    When included, a ":read" command with a file name
  1450.             argument will set the file name for the current buffer,
  1451.             if the current buffer doesn't have a file name yet.
  1452.         F    When included, a ":write" command with a file name
  1453.             argument will set the file name for the current
  1454.             buffer, if the current buffer doesn't have a file name
  1455.             yet.
  1456.         i    When included, interrupting the reading of a file will
  1457.             leave it modified.
  1458.         j    When joining lines, only add two spaces after a '.',
  1459.             not after '!' or '?'.  Also see 'joinspaces'.
  1460.         J    A |sentence| has to be followed by two spaces after
  1461.             the '.', '!' or '?'. A <Tab> is not recognized as
  1462.             white space.
  1463.         k    Disable the recognition of raw key codes in
  1464.             mappings, abbreviations, and the "to" part of menu
  1465.             commands.  For example, if <Key> sends ^[OA (where ^[
  1466.             is <Esc>), the command ":map X ^[OA" results in X
  1467.             being mapped to:
  1468.                 'k' included:   "^[OA"   (3 characters)
  1469.                 'k' excluded:   "<Key>"  (one key code)
  1470.             Also see the '<' flag below.
  1471.         K    Don't wait for a key code to complete when it is
  1472.             halfway a mapping.  This breaks mapping <F1><F1> when
  1473.             only part of the second <F1> has been read.  It
  1474.             enables cancelling the mapping by typing <F1><Esc>.
  1475.         l    Backslash in a [] range in a search pattern is taken
  1476.             literally, only "\]" is special  See |/[]|
  1477.                'l' included: "/[ \t]"  finds <Space>, '\' and 't'
  1478.                'l' excluded: "/[ \t]"  finds <Space> and <Tab>
  1479.         L    When the 'list' option is set, 'wrapmargin',
  1480.             'textwidth' and Virtual replace mode (see |gR|) count
  1481.             a <Tab> as two characters, instead of the normal
  1482.             behavior of a <Tab>.
  1483.         m    When included, a showmatch will always wait half a
  1484.             second.  When not included, a showmatch will wait half
  1485.             a second or until a character is typed.  |'showmatch'|
  1486.         n    When included, the column used for 'number' will also
  1487.             be used for text of wrapped lines.
  1488.         o    Line offset to search command is not remembered for
  1489.             next search.
  1490.         O    Don't complain if a file is being overwritten, even
  1491.             when it didn't exist when editing it.  This is a
  1492.             protection against a file unexpectedly created by
  1493.             someone else.  Vi didn't complain about this.
  1494.         p    Vi compatible Lisp indenting.  When not present, a
  1495.             slightly better algorithm is used.
  1496.         r    Redo ("." command) uses "/" to repeat a search
  1497.             command, instead of the actually used search string.
  1498.         s    Set buffer options when entering the buffer for the
  1499.             first time.  This is like it is in Vim version 3.0.
  1500.             And it is the default.  If not present the options are
  1501.             set when the buffer is created.
  1502.         S    Set buffer options always when entering a buffer
  1503.             (except 'readonly', 'fileformat', 'filetype' and
  1504.             'syntax').  This is the (most) Vi compatible setting.
  1505.             The options are set to the values in the current
  1506.             buffer.  When you change an option and go to another
  1507.             buffer, the value is copied.  Effectively makes the
  1508.             buffer options global to all buffers.
  1509.  
  1510.             's'    'S'     copy buffer options
  1511.             no     no      when buffer created
  1512.             yes    no      when buffer first entered (default)
  1513.              X     yes     each time when buffer entered (vi comp.)
  1514.  
  1515.         t    Search pattern for the tag command is remembered for
  1516.             "n" command.  Otherwise Vim only puts the pattern in
  1517.             the history for search pattern, but doesn't change the
  1518.             last used search pattern.
  1519.         u    Undo is Vi compatible.  See |undo-two-ways|.
  1520.         w    When using "cw" on a blank character, only change one
  1521.             character and not all blanks until the start of the
  1522.             next word.
  1523.         W    Don't overwrite a readonly file.  When omitted, ":w!"
  1524.             overwrites a readonly file, if possible.
  1525.         x    <Esc> on the command-line executes the command-line.
  1526.             The default in Vim is to abandon the command-line,
  1527.             because <Esc> normally aborts a command.  |c_<Esc>|
  1528.         y    A yank command can be redone with ".".
  1529.         !    When redoing a filter command, use the last used
  1530.             external command, whatever it was.  Otherwise the last
  1531.             used -filter- command is used.
  1532.         $    When making a change to one line, don't redisplay the
  1533.             line, but put a '$' at the end of the changed text.
  1534.             The changed text will be overwritten when you type the
  1535.             new text.  The line is redisplayed if you type any
  1536.             command that moves the cursor from the insertion
  1537.             point.
  1538.         %    Vi-compatible matching is done for the "%" command.
  1539.             Does not recognize "#if", "#endif", etc.
  1540.             Does not recognize "/*" and "*/".
  1541.             Parens inside single and double quotes are also
  1542.             counted, causing a string that contains a paren to
  1543.             disturb the matching.  For example, in a line like
  1544.             "if (strcmp("foo(", s))" the first paren does not
  1545.             match the last one.  When this flag is not included,
  1546.             parens inside single and double quotes are treated
  1547.             specially.  When matching a paren outside of quotes,
  1548.             everything inside quotes is ignored.  When matching a
  1549.             paren inside quotes, it will find the matching one (if
  1550.             there is one).  This works very well for C programs.
  1551.         *    Use ":*" in the same way as ":@".  When not included,
  1552.             ":*" is an alias for ":'<,'>", select the Visual area.
  1553.         <    Disable the recognition of special key codes in |<>|
  1554.             form in mappings, abbreviations, and the "to" part of
  1555.             menu commands.  For example, the command
  1556.             ":map X <Tab>" results in X being mapped to:
  1557.                 '<' included:   "<Tab>"  (5 characters)
  1558.                 '<' excluded:   "^I"     (^I is a real <Tab>)
  1559.             Also see the 'k' flag above.
  1560.  
  1561.                         *'cscopepathcomp'* *'cspc'*
  1562. 'cscopepathcomp' 'cspc'    number    (default 0)
  1563.             global
  1564.             {not available when compiled without the |+cscope|
  1565.             feature}
  1566.             {not in Vi}
  1567.     Determines how many components of the path to show in a list of tags.
  1568.     See |cscopepathcomp|.
  1569.  
  1570.                         *'cscopeprg'* *'csprg'*
  1571. 'cscopeprg' 'csprg'    string    (default "cscope")
  1572.             global
  1573.             {not available when compiled without the |+cscope|
  1574.             feature}
  1575.             {not in Vi}
  1576.     Specifies the command to execute cscope.  See |cscopeprg|.
  1577.     This option cannot be set from a |modeline|, for security reasons.
  1578.  
  1579.                 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
  1580. 'cscopetag' 'cst'    boolean (default off)
  1581.             global
  1582.             {not available when compiled without the |+cscope|
  1583.             feature}
  1584.             {not in Vi}
  1585.     Use cscope for tag commands.  See |cscope-options|.
  1586.     NOTE: This option is reset when 'compatible' is set.
  1587.  
  1588.                         *'cscopetagorder'* *'csto'*
  1589. 'cscopetagorder' 'csto'    number    (default 0)
  1590.             global
  1591.             {not available when compiled without the |+cscope|
  1592.             feature}
  1593.             {not in Vi}
  1594.     Determines the order in which ":cstag" performs a search.  See
  1595.     |cscopetagorder|.
  1596.     NOTE: This option is set to 0 when 'compatible' is set.
  1597.  
  1598.                     *'cscopeverbose'* *'csverb'*
  1599.                     *'nocscopeverbose'* *'nocsverb'*
  1600. 'cscopeverbose' 'csverb' boolean (default off)
  1601.             global
  1602.             {not available when compiled without the |+cscope|
  1603.             feature}
  1604.             {not in Vi}
  1605.     Give messages when adding a cscope database.  See |cscopeverbose|.
  1606.     NOTE: This option is reset when 'compatible' is set.
  1607.  
  1608.                         *'debug'*
  1609. 'debug'            string    (default "")
  1610.             global
  1611.             {not in Vi}
  1612.     When set to "msg", error messages that would otherwise be omitted will
  1613.     be given anyway.  This is useful when debugging 'foldexpr' or
  1614.     'indentexpr'.
  1615.  
  1616.                         *'define'* *'def'*
  1617. 'define' 'def'        string    (default "^#\s*define")
  1618.             global or local to buffer |global-local|
  1619.             {not in Vi}
  1620.     Pattern to be used to find a macro definition.  It is a search
  1621.     pattern, just like for the "/" command.  This option is used for the
  1622.     commands like "[i" and "[d" |include-search|.  The 'isident' option is
  1623.     used to recognize the defined name after the match:
  1624.         {match with 'define'}{non-ID chars}{defined name}{non-ID char}
  1625.     See |option-backslash| about inserting backslashes to include a space
  1626.     or backslash.
  1627.     The default value is for C programs.  For C++ this value would be
  1628.     useful, to include const type declarations: >
  1629.         ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
  1630. <    When using the ":set" command, you need to double the backslashes!
  1631.  
  1632.                         *'delcombine'* *'deco'*
  1633. 'delcombine' 'deco'    boolean (default off)
  1634.             global
  1635.             {not in Vi}
  1636.             {only available when compiled with the |+multi_byte|
  1637.             feature}
  1638.     If editing Unicode and this option is set, backspace and Normal mode
  1639.     "x" delete each combining character on its own.  When it is off (the
  1640.     default) the character along with its combining characters are
  1641.     deleted.
  1642.  
  1643.     This is useful for Hebrew or other languages where one may have
  1644.     combining characters overtop of base characters, and want to remove
  1645.     only the combining ones.
  1646.  
  1647.                         *'dictionary'* *'dict'*
  1648. 'dictionary' 'dict'    string    (default "")
  1649.             global or local to buffer |global-local|
  1650.             {not in Vi}
  1651.     List of file names, separated by commas, that are used to lookup words
  1652.     for keyword completion commands |i_CTRL-X_CTRL-K|.  Each file should
  1653.     contain a list of words.  This can be one word per line, or several
  1654.     words per line, separated by non-keyword characters (white space is
  1655.     preferred).  Maximum line length is 510 bytes.
  1656.     To include a comma in a file name precede it with a backslash.  Spaces
  1657.     after a comma are ignored, otherwise spaces are included in the file
  1658.     name.  See |option-backslash| about using backslashes.
  1659.     Where to find a list of words?
  1660.     - On FreeBSD, there is the file "/usr/share/dict/words".
  1661.     - In the Simtel archive, look in the "msdos/linguist" directory.
  1662.     - In "miscfiles" of the GNU collection.
  1663.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  1664.     directories from the list.  This avoids problems when a future version
  1665.     uses another default.
  1666.     Backticks cannot be used in this option for security reasons.
  1667.  
  1668.                             *'diff'* *'nodiff'*
  1669. 'diff'            boolean    (default off)
  1670.             local to window
  1671.             {not in Vi}
  1672.             {not available when compiled without the |+diff|
  1673.             feature}
  1674.     Join the current window in the group of windows that shows differences
  1675.     between files.  See |vimdiff|.
  1676.  
  1677.                         *'dex'* *'diffexpr'*
  1678. 'diffexpr' 'dex'    string    (default "")
  1679.             global
  1680.             {not in Vi}
  1681.             {not available when compiled without the |+diff|
  1682.             feature}
  1683.     Expression which is evaluated to obtain an ed-style diff file from two
  1684.     versions of a file.  See |diff-diffexpr|.
  1685.  
  1686.                         *'dip'* *'diffopt'*
  1687. 'diffopt' 'dip'        string    (default "filler")
  1688.             global
  1689.             {not in Vi}
  1690.             {not available when compiled without the |+diff|
  1691.             feature}
  1692.     Option settings for diff mode.  It can consist of the following items.
  1693.     All are optional.  Items must be separated by a comma.
  1694.  
  1695.         filler        Show filler lines, to keep the text
  1696.                 synchronized with a window that has inserted
  1697.                 lines at the same position.  Mostly useful
  1698.                 when windows are side-by-side and 'scrollbind'
  1699.                 is set.
  1700.  
  1701.         context:{n}    Use a context of {n} lines between a change
  1702.                 and a fold that contains unchanged lines.
  1703.                 When omitted a context of six lines is used.
  1704.                 See |fold-diff|.
  1705.  
  1706.         icase        Ignore changes in case of text.  "a" and "A"
  1707.                 are considered the same.  Adds the "-i" flag
  1708.                 to the "diff" command if 'diffexpr' is empty.
  1709.  
  1710.         iwhite        Ignore changes in amount of white space.  Adds
  1711.                 the "-b" flag to the "diff" command if
  1712.                 'diffexpr' is empty.  Check the documentation
  1713.                 of the "diff" command for what this does
  1714.                 exactly.  It should ignore adding trailing
  1715.                 white space, but not leading white space.
  1716.  
  1717.     Examples: >
  1718.  
  1719.         :set diffopt=filler,context:4
  1720.         :set diffopt=
  1721.         :set diffopt=filler
  1722. <
  1723.                      *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
  1724. 'digraph' 'dg'        boolean    (default off)
  1725.             global
  1726.             {not in Vi}
  1727.             {not available when compiled without the |+digraphs|
  1728.             feature}
  1729.     Enable the entering of digraphs in Insert mode with {char1} <BS>
  1730.     {char2}.  See |digraphs|.
  1731.     NOTE: This option is reset when 'compatible' is set.
  1732.  
  1733.                         *'directory'* *'dir'*
  1734. 'directory' 'dir'    string    (default for Amiga: ".,t:",
  1735.                  for MS-DOS and Win32: ".,c:\tmp,c:\temp"
  1736.                  for Unix: ".,~/tmp,/var/tmp,/tmp")
  1737.             global
  1738.     List of directory names for the swap file, separated with commas.
  1739.     - The swap file will be created in the first directory where this is
  1740.       possible.
  1741.     - Empty means that no swap file will be used (recovery is
  1742.       impossible!).
  1743.     - A directory "." means to put the swap file in the same directory as
  1744.       the edited file.  On Unix, a dot is prepended to the file name, so
  1745.       it doesn't show in a directory listing.
  1746.     - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
  1747.       put the swap file relative to where the edited file is.  The leading
  1748.       "." is replaced with the path name of the edited file.
  1749.     - For Unix and Win32, if a directory ends in two path separators, the
  1750.       swap file name will be built from the complete path to the file
  1751.       with all path separators substituted to percent '%' signs. This will
  1752.       ensure file name uniqueness in the preserve directory.
  1753.     - Spaces after the comma are ignored, other spaces are considered part
  1754.       of the directory name.  To have a space at the start of a directory
  1755.       name, precede it with a backslash.
  1756.     - To include a comma in a directory name precede it with a backslash.
  1757.     - A directory name may end in an ':' or '/'.
  1758.     - Environment variables are expanded |:set_env|.
  1759.     - Careful with '\' characters, type one before a space, type two to
  1760.       get one in the option (see |option-backslash|), for example: >
  1761.         :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
  1762. <    - For backwards compatibility with Vim version 3.0 a '>' at the start
  1763.       of the option is removed.
  1764.     Using "." first in the list is recommended.  This means that editing
  1765.     the same file twice will result in a warning.  Using "/tmp" on Unix is
  1766.     discouraged: When the system crashes you lose the swap file.
  1767.     "/var/tmp" is often not cleared when rebooting, thus is a better
  1768.     choice than "/tmp".  But it can contain a lot of files, your swap
  1769.     files get lost in the crowd.  That is why a "tmp" directory in your
  1770.     home directory is tried first.
  1771.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  1772.     directories from the list.  This avoids problems when a future version
  1773.     uses another default.
  1774.     This option cannot be set from a |modeline|, for security reasons.
  1775.     {Vi: directory to put temp file in, defaults to "/tmp"}
  1776.  
  1777.                     *'display'* *'dy'*
  1778. 'display' 'dy'        string    (default "")
  1779.             global
  1780.             {not in Vi}
  1781.     Change the way text is displayed.  This is comma separated list of
  1782.     flags:
  1783.     lastline    When included, as much as possible of the last line
  1784.             in a window will be displayed.  When not included, a
  1785.             last line that doesn't fit is replaced with "@" lines.
  1786.     uhex        Show unprintable characters hexadecimal as <xx>
  1787.             instead of using ^C and ~C.
  1788.  
  1789.                         *'eadirection'* *'ead'*
  1790. 'eadirection' 'ead'    string    (default "both")
  1791.             global
  1792.             {not in Vi}
  1793.             {not available when compiled without the +vertsplit
  1794.             feature}
  1795.     Tells when the 'equalalways' option applies:
  1796.         ver    vertically, width of windows is not affected
  1797.         hor    horizontally, height of windows is not affected
  1798.         both    width and height of windows is affected
  1799.  
  1800.                *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
  1801. 'edcompatible' 'ed'    boolean    (default off)
  1802.             global
  1803.     Makes the 'g' and 'c' flags of the ":substitute" command to be
  1804.     toggled each time the flag is given.  See |complex-change|.  See
  1805.     also 'gdefault' option.
  1806.     Switching this option on is discouraged!
  1807.  
  1808.                     *'encoding'* *'enc'*
  1809. 'encoding' 'enc'    string (default: "latin1" or value from $LANG)
  1810.             global
  1811.             {only available when compiled with the |+multi_byte|
  1812.             feature}
  1813.             {not in Vi}
  1814.     Sets the character encoding used inside Vim.  It applies to text in
  1815.     the buffers, registers, Strings in expressions, text stored in the
  1816.     viminfo file, etc.  It sets the kind of characters which Vim can work
  1817.     with.  See |encoding-names| for the possible values.
  1818.  
  1819.     NOTE: Changing this option will not change the encoding of the
  1820.     existing text in Vim.  It may cause multi-byte text to become invalid.
  1821.     It should normally be kept at its default value, or set when Vim
  1822.     starts up.  See |multibyte|.
  1823.  
  1824.     The character encoding of files can be different from 'encoding'.
  1825.     This is specified with 'fileencoding'.  The conversion is done with
  1826.     iconv() or as specified with 'charconvert'.
  1827.  
  1828.     Normally 'encoding' will be equal to your current locale.  This will
  1829.     be the default if Vim recognizes your environment settings.  If
  1830.     'encoding' is not set to the current locale, 'termencoding' must be
  1831.     set to convert typed and displayed text.  See |encoding-table|.
  1832.  
  1833.     When you set this option, it fires the |EncodingChanged| autocommand
  1834.     event so that you can set up fonts if necessary.
  1835.  
  1836.     When the option is set, the value is converted to lowercase.  Thus
  1837.     you can set it with uppercase values too.  Underscores are translated
  1838.     to '-' signs.
  1839.     When the encoding is recognized, it is changed to the standard name.
  1840.     For example "Latin-1" becomes "latin1", "ISO_88592" becomes
  1841.     "iso-8859-2" and "utf8" becomes "utf-8".
  1842.  
  1843.     Note: "latin1" is also used when the encoding could not be detected.
  1844.     This only works when editing files in the same encoding!  When the
  1845.     actual characterset is not latin1, make sure 'fileencoding' and
  1846.     'fileencodings' are empty.  When conversion is needed, switch to using
  1847.     utf-8.
  1848.  
  1849.     When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
  1850.     You don't notice this while editing, but it does matter for the
  1851.     |viminfo-file|.  And Vim expects the terminal to use utf-8 too.  Thus
  1852.     setting 'encoding' to one of these values instead of utf-8 only has
  1853.     effect for encoding used for files when 'fileencoding' is empty.
  1854.  
  1855.      When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
  1856.      not set yet, the default for 'fileencodings' is changed.
  1857.  
  1858.             *'endofline'* *'eol'* *'noendofline'* *'noeol'*
  1859. 'endofline' 'eol'    boolean    (default on)
  1860.             local to buffer
  1861.             {not in Vi}
  1862.     When writing a file and this option is off and the 'binary' option
  1863.     is on, no <EOL> will be written for the last line in the file.  This
  1864.     option is automatically set when starting to edit a new file, unless
  1865.     the file does not have an <EOL> for the last line in the file, in
  1866.     which case it is reset.  Normally you don't have to set or reset this
  1867.     option.  When 'binary' is off the value is not used when writing the
  1868.     file.  When 'binary' is on it is used to remember the presence of a
  1869.     <EOL> for the last line in the file, so that when you write the file
  1870.     the situation from the original file can be kept.  But you can change
  1871.     it if you want to.
  1872.  
  1873.                  *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
  1874. 'equalalways' 'ea'    boolean    (default on)
  1875.             global
  1876.             {not in Vi}
  1877.     When on, all the windows are automatically made the same size after
  1878.     splitting or closing a window.  When off, splitting a window will
  1879.     reduce the size of the current window and leave the other windows the
  1880.     same.  When closing a window the extra lines are given to the window
  1881.     next to it (depending on 'splitbelow' and 'splitright').
  1882.     When mixing vertically and horizontally split windows, a minimal size
  1883.     is computed and some windows may be larger if there is room.  The
  1884.     'eadirection' option tells in which direction the size is affected.
  1885.  
  1886.                         *'equalprg'* *'ep'*
  1887. 'equalprg' 'ep'        string    (default "")
  1888.             global or local to buffer |global-local|
  1889.             {not in Vi}
  1890.     External program to use for "=" command.  When this option is empty
  1891.     the internal formatting functions are used ('lisp', 'cindent' or
  1892.     'indentexpr').
  1893.     Environment variables are expanded |:set_env|.  See |option-backslash|
  1894.     about including spaces and backslashes.
  1895.     This option cannot be set from a |modeline|, for security reasons.
  1896.  
  1897.             *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
  1898. 'errorbells' 'eb'    boolean    (default off)
  1899.             global
  1900.     Ring the bell (beep or screen flash) for error messages.  This only
  1901.     makes a difference for error messages, the bell will be used always
  1902.     for a lot of errors without a message (e.g., hitting <Esc> in Normal
  1903.     mode).  See 'visualbell' on how to make the bell behave like a beep,
  1904.     screen flash or do nothing.
  1905.  
  1906.                         *'errorfile'* *'ef'*
  1907. 'errorfile' 'ef'    string    (Amiga default: "AztecC.Err",
  1908.                     others: "errors.err")
  1909.             global
  1910.             {not in Vi}
  1911.             {not available when compiled without the |+quickfix|
  1912.             feature}
  1913.     Name of the errorfile for the QuickFix mode (see |:cf|).
  1914.     When the "-q" command-line argument is used, 'errorfile' is set to the
  1915.     following argument.  See |-q|.
  1916.     NOT used for the ":make" command.  See 'makeef' for that.
  1917.     Environment variables are expanded |:set_env|.
  1918.     See |option-backslash| about including spaces and backslashes.
  1919.     This option cannot be set from a |modeline|, for security reasons.
  1920.  
  1921.                         *'errorformat'* *'efm'*
  1922. 'errorformat' 'efm'    string    (default is very long)
  1923.             global or local to buffer |global-local|
  1924.             {not in Vi}
  1925.             {not available when compiled without the |+quickfix|
  1926.             feature}
  1927.     Scanf-like description of the format for the lines in the error file
  1928.     (see |errorformat|).
  1929.  
  1930.                      *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
  1931. 'esckeys' 'ek'        boolean    (Vim default: on, Vi default: off)
  1932.             global
  1933.             {not in Vi}
  1934.     Function keys that start with an <Esc> are recognized in Insert
  1935.     mode.  When this option is off, the cursor and function keys cannot be
  1936.     used in Insert mode if they start with an <Esc>.  The advantage of
  1937.     this is that the single <Esc> is recognized immediately, instead of
  1938.     after one second.  Instead of resetting this option, you might want to
  1939.     try changing the values for 'timeoutlen' and 'ttimeoutlen'.  Note that
  1940.     when 'esckeys' is off, you can still map anything, but the cursor keys
  1941.     won't work by default.
  1942.     NOTE: This option is set to the Vi default value when 'compatible' is
  1943.     set and to the Vim default value when 'compatible' is reset.
  1944.  
  1945.                         *'eventignore'* *'ei'*
  1946. 'eventignore' 'ei'    string    (default "")
  1947.             global
  1948.             {not in Vi}
  1949.             {not available when compiled without the |+autocmd|
  1950.             feature}
  1951.     A list of autocommand event names, which are to be ignored.
  1952.     When set to "all", all autocommand events are ignored, autocommands
  1953.     will not be executed.
  1954.     Otherwise this is a comma separated list of event names.  Example: >
  1955.         :set ei=WinEnter,WinLeave
  1956. <
  1957.                  *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
  1958. 'expandtab' 'et'    boolean    (default off)
  1959.             local to buffer
  1960.             {not in Vi}
  1961.     In Insert mode: Use the appropriate number of spaces to insert a
  1962.     <Tab>.  Spaces are used in indents with the '>' and '<' commands and
  1963.     when 'autoindent' is on.  To insert a real tab when 'expandtab' is
  1964.     on, use CTRL-V<Tab>.  See also |:retab| and |ins-expandtab|.
  1965.     NOTE: This option is reset when 'compatible' is set.
  1966.  
  1967.                     *'exrc'* *'ex'* *'noexrc'* *'noex'*
  1968. 'exrc' 'ex'        boolean (default off)
  1969.             global
  1970.             {not in Vi}
  1971.     Enables the reading of .vimrc, .exrc and .gvimrc in the current
  1972.     directory.  If you switch this option on you should also consider
  1973.     setting the 'secure' option (see |initialization|).  Using a local
  1974.     .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
  1975.     also see |.vimrc| and |gui-init|.
  1976.     This option cannot be set from a |modeline|, for security reasons.
  1977.  
  1978.                 *'fileencoding'* *'fenc'* *E213*
  1979. 'fileencoding' 'fenc'    string (default: "")
  1980.             local to buffer
  1981.             {only available when compiled with the |+multi_byte|
  1982.             feature}
  1983.             {not in Vi}
  1984.     Sets the character encoding for the file of this buffer.
  1985.     When 'fileencoding' is different from 'encoding', conversion will be
  1986.     done when reading and writing the file.
  1987.     When 'fileencoding' is empty, the same value as 'encoding' will be
  1988.     used (no conversion when reading or writing a file).
  1989.         WARNING: Conversion can cause loss of information!  When
  1990.         'encoding' is "utf-8" conversion is most likely done in a way
  1991.         that the reverse conversion results in the same text.  When
  1992.         'encoding' is not "utf-8" some characters may be lost!
  1993.     See 'encoding' for the possible values.  Additionally, values may be
  1994.     specified that can be handled by the converter (either iconv() or
  1995.     specified with 'charconvert').
  1996.     When reading a file 'fileencoding' will be set from 'fileencodings'.
  1997.     To read a file in a certain encoding it won't work by setting
  1998.     'fileencoding', use the |++enc| argument.
  1999.     Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
  2000.     When the option is set, the value is converted to lowercase.  Thus
  2001.     you can set it with uppercase values too.  '_' characters are
  2002.     replaced with '-'.  If a name is recognized from the list for
  2003.     'encoding', it is replaced by the standard name.  For example
  2004.     "ISO8859-2" becomes "iso-8859-2".
  2005.     When this option is set, after starting to edit a file, the 'modified'
  2006.     option is set, because the file would be different when written.
  2007.     This option can not be changed when 'modifiable' is off.
  2008.  
  2009.                             *'fe'*
  2010.     NOTE: Before version 6.0 this option specified the encoding for the
  2011.     whole of Vim, this was a mistake.  Now use 'encoding' instead.  The
  2012.     old short name was 'fe', which is no longer used.
  2013.  
  2014.                     *'fileencodings'* *'fencs'*
  2015. 'fileencodings' 'fencs'    string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
  2016.                     when 'encoding' is set to a Unicode value)
  2017.             global
  2018.             {only available when compiled with the |+multi_byte|
  2019.             feature}
  2020.             {not in Vi}
  2021.     This is a list of character encodings considered when editing a file.
  2022.     When a file is read, Vim tries to use the first mentioned character
  2023.     encoding.  If an error is detected, the next one in the list is tried.
  2024.     When an encoding is found that works, 'fileencoding' is set to it.
  2025.     If all fail, 'fileencoding' is set to an empty string, which means
  2026.     the value of 'encoding' is used.
  2027.         WARNING: Conversion can cause loss of information!  When
  2028.         'encoding' is "utf-8" (or one of the other Unicode variants)
  2029.         conversion is most likely done in a way that the reverse
  2030.         conversion results in the same text.  When 'encoding' is not
  2031.         "utf-8" special characters may be lost!
  2032.     The special value "ucs-bom" can be used to check for a Unicode BOM
  2033.     (Byte Order Mark) at the start of the file.  It must not be preceded
  2034.     by "utf-8" or another Unicode encoding for this to work properly.
  2035.     If 'fileencodings' is empty, 'fileencoding' is not modified.
  2036.     See 'encoding' for the possible values.  Additionally, values may be
  2037.     specified that can be handled by the converter (either iconv() or
  2038.     specified with 'charconvert').
  2039.     Old versions of GNU iconv() may cause the conversion to fail (they
  2040.     request a very large buffer, more than Vim is willing to provide).
  2041.     Try getting another iconv() implementation.
  2042.     Unlike 'filecharcode' there is no conversion when the option is set.
  2043.  
  2044.                     *'fileformat'* *'ff'*
  2045. 'fileformat' 'ff'    string (MS-DOS, MS-Windows, OS/2 default: "dos",
  2046.                 Unix default: "unix",
  2047.                 Macintosh default: "mac")
  2048.             local to buffer
  2049.             {not in Vi}
  2050.     This gives the <EOL> of the current buffer, which is used for
  2051.     reading/writing the buffer from/to a file:
  2052.         dos        <CR> <NL>
  2053.         unix    <NL>
  2054.         mac        <CR>
  2055.     When "dos" is used, CTRL-Z at the end of a file is ignored.
  2056.     See |file-formats| and |file-read|.
  2057.     For the character encoding of the file see 'fileencoding'.
  2058.     When 'binary' is set, the value of 'fileformat' is ignored, file I/O
  2059.     works like it was set to "unix'.
  2060.     This option is set automatically when starting to edit a file and
  2061.     'fileformats' is not empty and 'binary' is off.
  2062.     When this option is set, after starting to edit a file, the 'modified'
  2063.     option is set, because the file would be different when written.
  2064.     This option can not be changed when 'modifiable' is off.
  2065.     For backwards compatibility: When this option is set to "dos",
  2066.     'textmode' is set, otherwise 'textmode' is reset.
  2067.  
  2068.                     *'fileformats'* *'ffs'*
  2069. 'fileformats' 'ffs'    string (default:
  2070.                 Vim+Vi    MS-DOS, MS-Windows OS/2: "dos,unix",
  2071.                 Vim    Unix: "unix,dos",
  2072.                 Vim    Mac: "mac,unix,dos",
  2073.                 Vi    others: "")
  2074.             global
  2075.             {not in Vi}
  2076.     This gives the end-of-line (<EOL>) formats that will be tried.  It is
  2077.     used when starting to edit a new buffer and when reading a file into
  2078.     an existing buffer:
  2079.     - When empty, the format defined with 'fileformat' will be used
  2080.       always.  It is not set automatically.
  2081.     - When set to one name, that format will be used whenever a new buffer
  2082.       is opened.  'fileformat' is set accordingly for that buffer.  The
  2083.       'fileformats' name will be used when a file is read into an existing
  2084.       buffer, no matter what 'fileformat' for that buffer is set to.
  2085.     - When more than one name is present, separated by commas, automatic
  2086.       <EOL> detection will be done when reading a file.  When starting to
  2087.       edit a file, a check is done for the <EOL>:
  2088.       1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
  2089.          'fileformat' is set to "dos".
  2090.       2. If a <NL> is found and 'fileformats' includes "unix, 'fileformat'
  2091.          is set to "unix".  Note that when a <NL> is found without a
  2092.          preceding <CR>, "unix" is preferred over "dos".
  2093.       3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
  2094.          This means that "mac" is only chosen when "unix" is not present,
  2095.          or when no <NL> is found in the file, and when "dos" is not
  2096.          present, or no <CR><NL> is present in the file.
  2097.          Also if "unix" was first chosen, but the first <CR> is before
  2098.          the first <NL> and there appears to be more <CR>'s than <NL>'s in
  2099.          the file, then 'fileformat' is set to "mac".
  2100.       4. If 'fileformat' is still not set, the first name from
  2101.          'fileformats' is used.
  2102.       When reading a file into an existing buffer, the same is done, but
  2103.       this happens like 'fileformat' has been set appropriately for that
  2104.       file only, the option is not changed.
  2105.     When 'binary' is set, the value of 'fileformats' is not used.
  2106.  
  2107.     For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
  2108.     are ":source"ed and for vimrc files, automatic <EOL> detection may be
  2109.     done:
  2110.     - When 'fileformats' is empty, there is no automatic detection.  Dos
  2111.       format will be used.
  2112.     - When 'fileformats' is set to one or more names, automatic detection
  2113.       is done.  This is based on the first <NL> in the file: If there is a
  2114.       <CR> in front of it, Dos format is used, otherwise Unix format is
  2115.       used.
  2116.     Also see |file-formats|.
  2117.     For backwards compatibility: When this option is set to an empty
  2118.     string or one format (no comma is included), 'textauto' is reset,
  2119.     otherwise 'textauto' is set.
  2120.     NOTE: This option is set to the Vi default value when 'compatible' is
  2121.     set and to the Vim default value when 'compatible' is reset.
  2122.  
  2123.                     *'filetype'* *'ft'*
  2124. 'filetype' 'ft'        string (default: "")
  2125.             local to buffer
  2126.             {not in Vi}
  2127.             {not available when compiled without the |+autocmd|
  2128.             feature}
  2129.     When this option is set, the FileType autocommand event is triggered.
  2130.     All autocommands that match with the value of this option will be
  2131.     executed.  Thus the value of 'filetype' is used in place of the file
  2132.     name.
  2133.     Otherwise this option does not always reflect the current file type.
  2134.     This option is normally set when the file type is detected.  To enable
  2135.     this use the ":filetype on" command. |:filetype|
  2136.     Setting this option to a different value is most useful in a modeline,
  2137.     for a file for which the file type is not automatically recognized.
  2138.     Example, for in an IDL file: >
  2139.         /* vim: set filetype=idl : */
  2140. <    |FileType| |filetypes|
  2141.     Do not confuse this option with 'osfiletype', which is for the file
  2142.     type that is actually stored with the file.
  2143.     This option is not copied to another buffer, independent of the 's' or
  2144.     'S' flag in 'cpoptions'.
  2145.  
  2146.                         *'fillchars'* *'fcs'*
  2147. 'fillchars' 'fcs'    string    (default "vert:|,fold:-")
  2148.             global
  2149.             {not in Vi}
  2150.             {not available when compiled without the |+windows|
  2151.             and |+folding| features}
  2152.     Characters to fill the statuslines and vertical separators.
  2153.     It is a comma separated list of items:
  2154.  
  2155.       item        default        Used for ~
  2156.       stl:c        ' ' or '^'    statusline of the current window
  2157.       stlnc:c    ' ' or '-'    statusline of the non-current windows
  2158.       vert:c    '|'        vertical separators |:vsplit|
  2159.       fold:c    '-'        filling 'foldtext'
  2160.       diff:c    '-'        deleted lines of the 'diff' option
  2161.  
  2162.     Any one that is omitted will fall back to the default.  For "stl" and
  2163.     "stlnc" the space will be used when there is highlighting, '^' or '-'
  2164.     otherwise.
  2165.  
  2166.     Example: >
  2167.         :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
  2168. <    This is similar to the default, except that these characters will also
  2169.     be used when there is highlighting.
  2170.  
  2171.     The highlighting used for these items:
  2172.       item        highlight group ~
  2173.       stl:c        StatusLine        |hl-StatusLine|
  2174.       stlnc:c    StatusLineNC        |hl-StatusLineNC|
  2175.       vert:c    VertSplit        |hl-VertSplit|
  2176.       fold:c    Folded            |hl-Folded|
  2177.       diff:c    DiffDelete        |hl-DiffDelete|
  2178.  
  2179.                     *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
  2180. 'fkmap' 'fk'        boolean (default off)            *E198*
  2181.             global
  2182.             {not in Vi}
  2183.             {only available when compiled with the |+rightleft|
  2184.             feature}
  2185.     When on, the keyboard is mapped for the Farsi character set.
  2186.     Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
  2187.     toggle this option |i_CTRL-_|.  See |farsi.txt|.
  2188.  
  2189.                         *'foldclose'* *'fcl'*
  2190. 'foldclose' 'fcl'    string (default "")
  2191.             global
  2192.             {not in Vi}
  2193.             {not available when compiled without the |+folding|
  2194.             feature}
  2195.     When set to "all", a fold is closed when the cursor isn't in it and
  2196.     its level is higher than 'foldlevel'.  Useful if you wants folds to
  2197.     automatically close when moving out of them.
  2198.  
  2199.                         *'foldcolumn'* *'fdc'*
  2200. 'foldcolumn' 'fdc'    number (default 0)
  2201.             local to window
  2202.             {not in Vi}
  2203.             {not available when compiled without the |+folding|
  2204.             feature}
  2205.     When non-zero, a column with the specified width is shown at the side
  2206.     of the window which indicates open and closed folds.  The maximum
  2207.     value is 12.
  2208.     See |folding|.
  2209.  
  2210.             *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
  2211. 'foldenable' 'fen'    boolean (default off)
  2212.             local to window
  2213.             {not in Vi}
  2214.             {not available when compiled without the |+folding|
  2215.             feature}
  2216.     When off, all folds are open.  This option can be used to quickly
  2217.     switch between showing all text unfolded and viewing the text with
  2218.     folds (including manually opened or closed folds).  It can be toggled
  2219.     with the |zi| command.  The 'foldcolumn' will remain blank when
  2220.     'foldenable' is off.
  2221.     This option is set by commands that create a new fold or close a fold.
  2222.     See |folding|.
  2223.  
  2224.                         *'foldexpr'* *'fde'*
  2225. 'foldexpr' 'fde'    string (default: "0")
  2226.             local to window
  2227.             {not in Vi}
  2228.             {not available when compiled without the |+folding|
  2229.             or |+eval| feature}
  2230.     The expression used for when 'foldmethod' is "expr".  It is evaluated
  2231.     for each line to obtain its fold level.  See |fold-expr|.  Also see
  2232.     |eval-sandbox|.
  2233.  
  2234.                         *'foldignore'* *'fdi'*
  2235. 'foldignore' 'fdi'    string (default: "#")
  2236.             local to window
  2237.             {not in Vi}
  2238.             {not available when compiled without the |+folding|
  2239.             feature}
  2240.     Used only when 'foldmethod' is "indent".  Lines starting with
  2241.     characters in 'foldignore' will get their fold level from surrounding
  2242.     lines.  White space is skipped before checking for this character.
  2243.     The default "#" works well for C programs.  See |fold-indent|.
  2244.  
  2245.                         *'foldlevel'* *'fdl'*
  2246. 'foldlevel' 'fdl'    number (default: 0)
  2247.             local to window
  2248.             {not in Vi}
  2249.             {not available when compiled without the |+folding|
  2250.             feature}
  2251.     Sets the fold level: Folds with a higher level will be closed.
  2252.     Setting this option to zero will close all folds.  Higher numbers will
  2253.     close less folds.
  2254.     This option is set by commands like |zm|, |zM| and |zR|.
  2255.     See |fold-foldlevel|.
  2256.  
  2257.                         *'foldlevelstart'* *'fdls'*
  2258. 'foldlevelstart' 'fdls'    number (default: -1)
  2259.             global
  2260.             {not in Vi}
  2261.             {not available when compiled without the |+folding|
  2262.             feature}
  2263.     Sets 'foldlevel' when starting to edit another buffer in a window.
  2264.     Useful to always start editing with all folds closed (value zero),
  2265.     some folds closed (one) or no folds closed (99).
  2266.     This is done before reading any modeline, thus a setting in a modeline
  2267.     overrules this option.  Starting to edit a file for |diff-mode| also
  2268.     ignores this option and closes all folds.
  2269.     It is also done before BufReadPre autocommands, to allow an autocmd to
  2270.     overrule the 'foldlevel' value for specific files.
  2271.     When the value is negative, it is not used.
  2272.  
  2273.                         *'foldmarker'* *'fmr'*
  2274. 'foldmarker' 'fmr'    string (default: "{{{,}}}")
  2275.             local to window
  2276.             {not in Vi}
  2277.             {not available when compiled without the |+folding|
  2278.             feature}
  2279.     The start and end marker used when 'foldmethod' is "marker".  There
  2280.     must be one comma, which separates the start and end marker.  The
  2281.     marker is a literal string (a regular expression would be too slow).
  2282.     See |fold-marker|.
  2283.  
  2284.                         *'foldmethod'* *'fdm'*
  2285. 'foldmethod' 'fdm'    string (default: "manual")
  2286.             local to window
  2287.             {not in Vi}
  2288.             {not available when compiled without the |+folding|
  2289.             feature}
  2290.     The kind of folding used for the current window.  Possible values:
  2291.     |fold-manual|    manual        Folds are created manually.
  2292.     |fold-indent|    indent        Lines with equal indent form a fold.
  2293.     |fold-expr|    expr        'foldexpr' gives the fold level of a line.
  2294.     |fold-marker|    marker        Markers are used to specify folds.
  2295.     |fold-syntax|    syntax        Syntax highlighting items specify folds.
  2296.     |fold-diff|    diff        Fold text that is not changed.
  2297.  
  2298.                         *'foldminlines'* *'fml'*
  2299. 'foldminlines' 'fml'    number (default: 1)
  2300.             local to window
  2301.             {not in Vi}
  2302.             {not available when compiled without the |+folding|
  2303.             feature}
  2304.     Sets the minimum number of screen lines for a fold to be displayed
  2305.     closed.  Also for manually closed folds.
  2306.  
  2307.                         *'foldnestmax'* *'fdn'*
  2308. 'foldnestmax' 'fdn'    number (default: 20)
  2309.             local to window
  2310.             {not in Vi}
  2311.             {not available when compiled without the |+folding|
  2312.             feature}
  2313.     Sets the maximum nesting of folds for the "indent" and "syntax"
  2314.     methods.  This avoids that too many folds will be created.  Using more
  2315.     than 20 doesn't work, because the internal limit is 20.
  2316.  
  2317.                         *'foldopen'* *'fdo'*
  2318. 'foldopen' 'fdo'    string (default: "block,hor,mark,percent,quickfix,
  2319.                                  search,tag,undo")
  2320.             global
  2321.             {not in Vi}
  2322.             {not available when compiled without the |+folding|
  2323.             feature}
  2324.     Specifies for which type of commands folds will be opened, if the
  2325.     command moves the cursor into a closed fold.  It is a comma separated
  2326.     list of items.
  2327.         item        commands ~
  2328.         all        any
  2329.         block        "(", "{", "[[", "[{", etc.
  2330.         hor        horizontal movements: "l", "w", "fx", etc.
  2331.         insert        any command in Insert mode
  2332.         jump        far jumps: "G", "gg", etc.
  2333.         mark        jumping to a mark: "'m", CTRL-O, etc.
  2334.         percent        "%"
  2335.         quickfix    ":cn", ":crew", ":make", etc.
  2336.         search        search for a pattern: "/", "n", "*", "gd", etc.
  2337.         tag        jumping to a tag: ":ta", CTRL-T, etc.
  2338.         undo        undo or redo: "u" and CTRL-R
  2339.     When the command is part of a mapping this option is not used.  Add
  2340.     the |zv| command to the mapping to get the same effect.
  2341.     When a movement command is used for an operator (e.g., "dl" or "y%")
  2342.     this option is not used.  This means the operator will include the
  2343.     whole closed fold.
  2344.     Note that vertical movements are not here, because it would make it
  2345.     very difficult to move onto a closed fold.
  2346.     In insert mode the folds containing the cursor will always be open
  2347.     when text is inserted.
  2348.     To close folds you can re-apply 'foldlevel' with the |zx| command or
  2349.     set the 'foldclose' option to "all".
  2350.  
  2351.                         *'foldtext'* *'fdt'*
  2352. 'foldtext' 'fdt'    string (default: "foldtext()")
  2353.             local to window
  2354.             {not in Vi}
  2355.             {not available when compiled without the |+folding|
  2356.             feature}
  2357.     An expression which is used to specify the text displayed for a closed
  2358.     fold.  See |fold-foldtext|.
  2359.  
  2360.                     *'formatoptions'* *'fo'*
  2361. 'formatoptions' 'fo'    string (Vim default: "tcq", Vi default: "vt")
  2362.             local to buffer
  2363.             {not in Vi}
  2364.     This is a sequence of letters which describes how automatic
  2365.     formatting is to be done.  See |fo-table|.  When the 'paste' option is
  2366.     on, no formatting is done (like 'formatoptions' is empty).  Commas can
  2367.     be inserted for readability.
  2368.     To avoid problems with flags that are added in the future, use the
  2369.     "+=" and "-=" feature of ":set" |add-option-flags|.
  2370.     NOTE: This option is set to the Vi default value when 'compatible' is
  2371.     set and to the Vim default value when 'compatible' is reset.
  2372.  
  2373.                         *'formatprg'* *'fp'*
  2374. 'formatprg' 'fp'    string (default "")
  2375.             global
  2376.             {not in Vi}
  2377.     The name of an external program that will be used to format the lines
  2378.     selected with the "gq" command.  The program must take the input on
  2379.     stdin and produce the output on stdout.  The Unix program "fmt" is
  2380.     such a program.  If this option is an empty string, the internal
  2381.     format function will be used |C-indenting|.  Environment variables are
  2382.     expanded |:set_env|.  See |option-backslash| about including spaces
  2383.     and backslashes.
  2384.     This option cannot be set from a |modeline|, for security reasons.
  2385.  
  2386.                    *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
  2387. 'gdefault' 'gd'        boolean    (default off)
  2388.             global
  2389.             {not in Vi}
  2390.     When on, the ":substitute" flag 'g' is default on.  This means that
  2391.     all matches in a line are substituted instead of one.  When a 'g' flag
  2392.     is given to a ":substitute" command, this will toggle the substitution
  2393.     of all or one match.  See |complex-change|.
  2394.  
  2395.         command        'gdefault' on    'gdefault' off    ~
  2396.         :s///          subst. all      subst. one
  2397.         :s///g          subst. one      subst. all
  2398.         :s///gg          subst. all      subst. one
  2399.  
  2400.     NOTE: This option is reset when 'compatible' is set.
  2401.  
  2402.                         *'grepformat'* *'gfm'*
  2403. 'grepformat' 'gfm'    string    (default "%f:%l%m,%f  %l%m")
  2404.             global
  2405.             {not in Vi}
  2406.     Format to recognize for the ":grep" command output.
  2407.     This is a scanf-like string that uses the same format as the
  2408.     'errorformat' option: see |errorformat|.
  2409.  
  2410.                         *'grepprg'* *'gp'*
  2411. 'grepprg' 'gp'        string    (default "grep -n ",
  2412.                     Unix: "grep -n $* /dev/null",
  2413.                     Win32: "findstr /n" or "grep -n",
  2414.                               VMS: "SEARCH/NUMBERS ")
  2415.             global or local to buffer |global-local|
  2416.             {not in Vi}
  2417.     Program to use for the ":grep" command. This option may contain '%'
  2418.     and '#' characters, which are expanded like when used in a command-
  2419.     line.  The placeholder "$*" is allowed to specify where the arguments
  2420.     will be included.  Environment variables are expanded |:set_env|.  See
  2421.     |option-backslash| about including spaces and backslashes.
  2422.     When your "grep" accepts the "-H" argument, use this to make ":grep"
  2423.     also work well with a single file: >
  2424.         :set grepprg=grep\ -nH
  2425. <    See also the section |:make_makeprg|, since most of the comments there
  2426.     apply equally to 'grepprg'.
  2427.     For Win32, the default is "findstr /n" if "findstr.exe" can be found,
  2428.     otherwise it's "grep -n".
  2429.     This option cannot be set from a |modeline|, for security reasons.
  2430.  
  2431.                         *'guicursor'* *'gcr'*
  2432. 'guicursor' 'gcr'    string    (default "n-v-c:block-Cursor/lCursor,
  2433.                     ve:ver35-Cursor,
  2434.                     o:hor50-Cursor,
  2435.                     i-ci:ver25-Cursor/lCursor,
  2436.                     r-cr:hor20-Cursor/lCursor,
  2437.                     sm:block-Cursor
  2438.                     -blinkwait175-blinkoff150-blinkon175")
  2439.             global
  2440.             {not in Vi}
  2441.             {only available when compiled with GUI enabled, and
  2442.             for MSDOS and Win32 console}
  2443.     This option tells Vim what the cursor should look like in different
  2444.     modes.  The option is a comma separated list of parts.  Each part
  2445.     consist of a mode-list and an argument-list:
  2446.         mode-list:argument-list,mode-list:argument-list,..
  2447.     The mode-list is a dash separated list of these modes:
  2448.         n    Normal mode
  2449.         v    Visual mode
  2450.         ve    Visual mode with 'selection' "exclusive" (same as 'v',
  2451.             if not specified)
  2452.         o    Operator-pending mode
  2453.         i    Insert mode
  2454.         r    Replace mode
  2455.         c    Command-line Normal (append) mode
  2456.         ci    Command-line Insert mode
  2457.         cr    Command-line Replace mode
  2458.         sm    showmatch in Insert mode
  2459.         a    all modes
  2460.     The argument-list is a dash separated list of these arguments:
  2461.         hor{N}    horizontal bar, {N} percent of the character height
  2462.         ver{N}    vertical bar, {N} percent of the character width
  2463.         block    block cursor, fills the whole character
  2464.             [only one of the above three should be present]
  2465.         blinkwait{N}                *cursor-blinking*
  2466.         blinkon{N}
  2467.         blinkoff{N}
  2468.             blink times for cursor: blinkwait is the delay before
  2469.             the cursor starts blinking, blinkon is the time that
  2470.             the cursor is shown and blinkoff is the time that the
  2471.             cursor is not shown.  The times are in msec.  When one
  2472.             of the numbers is zero, there is no blinking.  The
  2473.             default is: "blinkwait700-blinkon400-blinkoff250".
  2474.             These numbers are used for a missing entry.  This
  2475.             means that blinking is enabled by default.  To switch
  2476.             blinking off you can use "blinkon0".  The cursor only
  2477.             blinks when Vim is waiting for input, not while
  2478.             executing a command.
  2479.             To make the cursor blink in an xterm, see
  2480.             |xterm-blink|.
  2481.         {group-name}
  2482.             a highlight group name, that sets the color and font
  2483.             for the cursor
  2484.         {group-name}/{group-name}
  2485.             Two highlight group names, the first is used when
  2486.             no language mappings are used, the other when they
  2487.             are. |language-mapping|
  2488.  
  2489.     Examples of parts:
  2490.        n-c-v:block-nCursor    in Normal, Command-line and Visual mode, use a
  2491.                 block cursor with colors from the "nCursor"
  2492.                 highlight group
  2493.        i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
  2494.                 In Insert and Command-line Insert mode, use a
  2495.                 30% vertical bar cursor with colors from the
  2496.                 "iCursor" highlight group.  Blink a bit
  2497.                 faster.
  2498.  
  2499.     The 'a' mode is different.  It will set the given argument-list for
  2500.     all modes.  It does not reset anything to defaults.  This can be used
  2501.     to do a common setting for all modes.  For example, to switch off
  2502.     blinking: "a:blinkon0"
  2503.  
  2504.     Examples of cursor highlighting: >
  2505.         :highlight Cursor gui=reverse guifg=NONE guibg=NONE
  2506.         :highlight Cursor gui=NONE guifg=bg guibg=fg
  2507. <
  2508.     In an MSDOS or Win32 console, only the height of the cursor can be
  2509.     changed.  This can be done by specifying a block cursor, or a
  2510.     percentage for a vertical or horizontal cursor.
  2511.  
  2512.                         *'guifont'* *'gfn'* *E235*
  2513. 'guifont' 'gfn'        string    (default "")
  2514.             global
  2515.             {not in Vi}
  2516.             {only available when compiled with GUI enabled}
  2517.     This is a list of fonts which will be used for the GUI version of Vim.
  2518.     In its simplest form the value is just one font name.  When
  2519.     the font cannot be found you will get an error message.  To try other
  2520.     font names a list can be specified, font names separated with commas.
  2521.     The first valid font is used.
  2522.     When 'guifontset' is not empty, 'guifont' is not used.
  2523.     Spaces after a comma are ignored.  To include a comma in a font name
  2524.     precede it with a backslash.  Setting an option requires an extra
  2525.     backslash before a space and a backslash.  See also
  2526.     |option-backslash|.  For example: >
  2527.         :set guifont=Screen15,\ 7x13,font\\,with\\,commas
  2528. <    will make vim try to use the font "Screen15" first, and if it fails it
  2529.     will try to use "7x13" and then "font,with,commas" instead.
  2530.                                 *E236*
  2531.     Note that the fonts must be mono-spaced (all characters have the same
  2532.     width).
  2533.     To preview a font on X11, you might be able to use the "xfontsel"
  2534.     program.  The "xlsfonts" program gives a list of all available fonts.
  2535.     For Win32, GTK and Photon only: >
  2536.         :set guifont=*
  2537. <    will bring up a font requester, where you can pick the font you want.
  2538.     If none of the fonts can be loaded, vim will keep the current setting.
  2539.     If an empty font list is given, vim will try using other resource
  2540.     settings (for X, it will use the Vim.font resource), and finally it
  2541.     will try some builtin default which should always be there ("7x13" in
  2542.     the case of X).  The font names given should be "normal" fonts.  Vim
  2543.     will try to find the related bold and italic fonts.
  2544.     For the Win32 GUI                    *E244* *E245*
  2545.     - takes these options in the font name:
  2546.         hXX - height is XX (points)
  2547.         wXX - width is XX (points)
  2548.         b   - bold
  2549.         i   - italic
  2550.         u   - underline
  2551.         s   - strikeout
  2552.         cXX - character set XX. valid charsets are: ANSI, ARABIC,
  2553.               BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
  2554.               HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
  2555.               SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
  2556.  
  2557.       Use a ':' to separate the options.
  2558.     - A '_' can be used in the place of a space, so you don't need to use
  2559.       backslashes to escape the spaces.
  2560.     - Example: >
  2561.         :set guifont=courier_new:h12:w5:b:cRUSSIAN
  2562. <    Have a look at <http://nova.bsuvc.bsu.edu/prn/monofont/> for
  2563.     mono-spaced fonts and comments on them.
  2564.     See also |font-sizes|.
  2565.  
  2566.                 *'guifontset'* *'gfs'* *E250* *E252* *E234*
  2567. 'guifontset' 'gfs'    string    (default "")
  2568.             global
  2569.             {not in Vi}
  2570.             {only available when compiled with GUI enabled and
  2571.             with the |+xfontset| feature}
  2572.     When not empty, specifies two (or more) fonts to be used.  The first
  2573.     one for normal English, the second one for your special language.  See
  2574.     |xfontset|.
  2575.     Setting this option also means that all font names will be handled as
  2576.     a fontset name.  Also the ones used for the "font" argument of the
  2577.     |:highlight| command.
  2578.     The fonts must match with the current locale.  If fonts for the
  2579.     character sets that the current locale uses are not included, setting
  2580.     'guifontset' will fail.
  2581.     Note the difference between 'guifont' and 'guifontset': In 'guifont'
  2582.     the comma-separated names are alternative names, one of which will be
  2583.     used.  In 'guifontset' the whole string is one fontset name,
  2584.     including the commas.  It is not possible to specify alternative
  2585.     fontset names.
  2586.     This example works on many X11 systems: >
  2587.         :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
  2588. <
  2589.                         *'guifontwide'* *'gfw'* *E231*
  2590. 'guifontwide' 'gfw'    string    (default "")
  2591.             global
  2592.             {not in Vi}
  2593.             {only available when compiled with GUI enabled}
  2594.     When not empty, specifies a comma-separated list of fonts to be used
  2595.     for double-width characters.  The first font that can be loaded is
  2596.     used.
  2597.     Note: The size of these fonts must be exactly twice as wide as the one
  2598.     specified with 'guifont' and the same height.
  2599.     Only used when 'encoding' is set to "utf-8" and 'guifontset' is empty
  2600.     or invalid.
  2601.     When 'guifont' is set and a valid font is found in it and
  2602.     'guifontwide' is empty Vim will attempt to find a matching
  2603.     double-width font and set 'guifontwide' to it.
  2604.  
  2605.                         *'guiheadroom'* *'ghr'*
  2606. 'guiheadroom' 'ghr'    number    (default 50)
  2607.             global
  2608.             {not in Vi} {only for GTK and X11 GUI}
  2609.     The number of pixels subtracted from the screen height when fitting
  2610.     the GUI window on the screen.  Set this before the GUI is started,
  2611.     e.g., in your |gvimrc| file.  When zero, the whole screen height will
  2612.     be used by the window.  When positive, the specified number of pixel
  2613.     lines will be left for window decorations and other items on the
  2614.     screen.  Set it to a negative value to allow windows taller than the
  2615.     screen.
  2616.  
  2617.                         *'guioptions'* *'go'*
  2618. 'guioptions' 'go'    string    (default "gmrLtT"   (MS-Windows),
  2619.                      "agimrLtT" (GTK, Motif and Athena)
  2620.             global
  2621.             {not in Vi}
  2622.             {only available when compiled with GUI enabled}
  2623.     This option only has an effect in the GUI version of vim.  It is a
  2624.     sequence of letters which describes what components and options of the
  2625.     GUI should be used.
  2626.     To avoid problems with flags that are added in the future, use the
  2627.     "+=" and "-=" feature of ":set" |add-option-flags|.
  2628.  
  2629.     Valid letters are as follows:
  2630.                             *guioptions_a*
  2631.       'a'    Autoselect:  If present, then whenever VISUAL mode is started,
  2632.         or the Visual area extended, Vim tries to become the owner of
  2633.         the windowing system's global selection.  This means that the
  2634.         Visually highlighted text is available for pasting into other
  2635.         applications as well as into Vim itself.  When the Visual mode
  2636.         ends, possibly due to an operation on the text, or when an
  2637.         application wants to paste the selection, the highlighted text
  2638.         is automatically yanked into the "* selection register.
  2639.         Thus the selection is still available for pasting into other
  2640.         applications after the VISUAL mode has ended.
  2641.             If not present, then Vim won't become the owner of the
  2642.         windowing system's global selection unless explicitly told to
  2643.         by a yank or delete operation for the "* register.
  2644.         The same applies to the modeless selection.
  2645.  
  2646.       'A'    Autoselect for the modeless selection.  Like 'a', but only
  2647.         applies to the modeless selection.
  2648.  
  2649.             'guioptions'   autoselect Visual  autoselect modeless ~
  2650.              ""         -             -
  2651.              "a"        yes            yes
  2652.              "A"         -            yes
  2653.              "aA"        yes            yes
  2654.  
  2655.       'f'    Foreground: Don't use fork() to detach the GUI from the shell
  2656.         where it was started.  Use this for programs that wait for the
  2657.         editor to finish (e.g., an e-mail program).  Alternatively you
  2658.         can use "gvim -f" or ":gui -f" to start the GUI in the
  2659.         foreground.  |gui-fork|
  2660.         Note: Set this option in the vimrc file.  The forking may have
  2661.         happened already when the gvimrc file is read.
  2662.  
  2663.       'i'    Use a Vim icon.  For GTK with KDE it is used in the left-upper
  2664.         corner of the window.  It's black&white on non-GTK, because of
  2665.         limitations of X11.  For a color icon, see |X11-icon|.
  2666.  
  2667.       'm'    Menu bar is present.
  2668.       'M'    The system menu "$VIMRUNTIME/menu.vim" is not sourced.  Note
  2669.         that this flag must be added in the .vimrc file, before
  2670.         switching on syntax or filetype recognition (when the .gvimrc
  2671.         file is sourced the system menu has already been loaded; the
  2672.         ":syntax on" and ":filetype on" commands load the menu too).
  2673.       'g'    Grey menu items: Make menu items that are not active grey.  If
  2674.         'g' is not included inactive menu items are not shown at all.
  2675.         Exception: Athena will always use grey menu items.
  2676.  
  2677.       't'    Include tearoff menu items.  Currently only works for Win32,
  2678.         GTK+, and Motif 1.2 GUI.
  2679.       'T'    Include Toolbar.  Currently only in Win32, GTK+, Motif, and
  2680.         Athena GUIs.
  2681.  
  2682.       'r'    Right-hand scrollbar is always present.
  2683.       'R'    Right-hand scrollbar is present when there is a vertically
  2684.         split window.
  2685.       'l'    Left-hand scrollbar is always present.
  2686.       'L'    Left-hand scrollbar is present when there is a vertically
  2687.         split window.
  2688.       'b'    Bottom (horizontal) scrollbar is present.
  2689.  
  2690.     And yes, you may even have scrollbars on the left AND the right if
  2691.     you really want to :-).  See |gui-scrollbars| for more information.
  2692.  
  2693.       'v'    Use a vertical button layout for dialogs.  When not included,
  2694.         a horizontal layout is preferred, but when it doesn't fit a
  2695.         vertical layout is used anyway.
  2696.       'p'    Use Pointer callbacks for X11 GUI.  This is required for some
  2697.         window managers.  If the cursor is not blinking or hollow at
  2698.         the right moment, try adding this flag.  This must be done
  2699.         before starting the GUI.  Set it in your gvimrc.  Adding or
  2700.         removing it after the GUI has started has no effect.
  2701.       'F'    Add a footer.  Only for Motif.  See |gui-footer|.
  2702.  
  2703.                         *'guipty'* *'noguipty'*
  2704. 'guipty'        boolean    (default on)
  2705.             global
  2706.             {not in Vi}
  2707.             {only available when compiled with GUI enabled}
  2708.     Only in the GUI: If on, an attempt is made to open a pseudo-tty for
  2709.     I/O to/from shell commands.  See |gui-pty|.
  2710.  
  2711.                     *'helpfile'* *'hf'*
  2712. 'helpfile' 'hf'        string    (default (MSDOS)  "$VIMRUNTIME\doc\help.txt"
  2713.                      (others) "$VIMRUNTIME/doc/help.txt")
  2714.             global
  2715.             {not in Vi}
  2716.     Name of the help file.  All help files should be placed together in
  2717.     one directory.  Environment variables are expanded |:set_env|.  For
  2718.     example: "$VIMRUNTIME/doc/help.txt".  If $VIMRUNTIME is not set, $VIM
  2719.     is also tried.  Also see |$VIMRUNTIME| and |option-backslash|
  2720.     about including spaces and backslashes.
  2721.     This option cannot be set from a |modeline|, for security reasons.
  2722.  
  2723.                         *'helpheight'* *'hh'*
  2724. 'helpheight' 'hh'    number    (default 20)
  2725.             global
  2726.             {not in Vi}
  2727.             {not available when compiled without the +windows
  2728.             feature}
  2729.     Minimal initial height of the help window when it is opened with the
  2730.     ":help" command.  The initial height of the help window is half of the
  2731.     current window, or (when the 'ea' option is on) the same as other
  2732.     windows.  When the height is less than 'helpheight', the height is
  2733.     set to 'helpheight'.  Set to zero to disable.
  2734.  
  2735.                      *'hidden'* *'hid'* *'nohidden'* *'nohid'*
  2736. 'hidden' 'hid'        boolean    (default off)
  2737.             global
  2738.             {not in Vi}
  2739.     When off a buffer is unloaded when it is |abandon|ed.  When on a
  2740.     buffer becomes hidden when it is |abandon|ed.  If the buffer is still
  2741.     displayed in another window, it does not become hidden, of course.
  2742.     The commands that move through the buffer list sometimes make a buffer
  2743.     hidden although the 'hidden' option is off: When the buffer is
  2744.     modified, 'autowrite' is off or writing is not possible, and the '!'
  2745.     flag was used.  See also |windows.txt|.
  2746.     This option is set for one command with ":hide {command}" |:hide|.
  2747.     WARNING: It's easy to forget that you have changes in hidden buffers.
  2748.     Think twice when using ":q!" or ":qa!".
  2749.  
  2750.                         *'highlight'* *'hl'*
  2751. 'highlight' 'hl'    string    (default (as a single string):
  2752.                      "8:SpecialKey,@:NonText,d:Directory,
  2753.                      e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
  2754.                      M:ModeMsg,n:LineNr,r:Question,
  2755.                      s:StatusLine,S:StatusLineNC,c:VertSplit
  2756.                      t:Title,v:Visual,w:WarningMsg,W:WildMenu,
  2757.                      f:Folded,F:FoldColumn")
  2758.             global
  2759.             {not in Vi}
  2760.     This option can be used to set highlighting mode for various
  2761.     occasions.  It is a comma separated list of character pairs.  The
  2762.     first character in a pair gives the occasion, the second the mode to
  2763.     use for that occasion.  The occasions are:
  2764.     |hl-SpecialKey|     8  Meta and special keys listed with ":map"
  2765.     |hl-NonText|     @  '~' and '@' at the end of the window and
  2766.                 characters from 'showbreak'
  2767.     |hl-Directory|     d  directories in CTRL-D listing and other special
  2768.                 things in listings
  2769.     |hl-ErrorMsg|     e  error messages
  2770.              h  (obsolete, ignored)
  2771.     |hl-IncSearch|     i  'incsearch' highlighting
  2772.     |hl-Search|     l  last search pattern highlighting (see 'hlsearch')
  2773.     |hl-MoreMsg|     m  |more-prompt|
  2774.     |hl-ModeMsg|     M  Mode (e.g., "-- INSERT --")
  2775.     |hl-LineNr|     n  line number for ":number" and ":#" commands
  2776.     |hl-Question|     r  |hit-enter| prompt and yes/no questions
  2777.     |hl-StatusLine|     s  status line of current window |status-line|
  2778.     |hl-StatusLineNC| S  status lines of not-current windows
  2779.     |hl-Title|     t  Titles for output from ":set all", ":autocmd" etc.
  2780.     |hl-VertSplit|     c  column used to separate vertically split windows
  2781.     |hl-Visual|     v  Visual mode
  2782.     |hl-VisualNOS|     V  Visual mode when Vim does is "Not Owning the
  2783.                 Selection" Only X11 Gui's |gui-x11| and
  2784.                 |xterm-clipboard|.
  2785.     |hl-WarningMsg|     w  warning messages
  2786.     |hl-WildMenu|     W  wildcard matches displayed for 'wildmenu'
  2787.     |hl-Folded|     f  line used for closed folds
  2788.     |hl-FoldColumn|     F  'foldcolumn'
  2789.  
  2790.     The display modes are:
  2791.         r    reverse        (termcap entry "mr" and "me")
  2792.         i    italic        (termcap entry "ZH" and "ZR")
  2793.         b    bold        (termcap entry "md" and "me")
  2794.         s    standout    (termcap entry "so" and "se")
  2795.         u    underline    (termcap entry "us" and "ue")
  2796.         n    no highlighting
  2797.         -    no highlighting
  2798.         :    use a highlight group
  2799.     The default is used for occasions that are not included.
  2800.     If you want to change what the display modes do, see |dos-colors|
  2801.     for an example.
  2802.     When using the ':' display mode, this must be followed by the name of
  2803.     a highlight group.  A highlight group can be used to define any type
  2804.     of highlighting, including using color.  See |:highlight| on how to
  2805.     define one.  The default uses a different group for each occasion.
  2806.     See |highlight-default| for the default highlight groups.
  2807.  
  2808.                  *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
  2809. 'hlsearch' 'hls'    boolean    (default off)
  2810.             global
  2811.             {not in Vi}
  2812.             {not available when compiled without the
  2813.             |+extra_search| feature}
  2814.     When there is a previous search pattern, highlight all its matches.
  2815.     The type of highlighting used can be set with the 'l' occasion in the
  2816.     'highlight' option.  This uses the "Search" highlight group by
  2817.     default.  Note that only the matching text is highlighted, any offsets
  2818.     are not applied.
  2819.     See also: 'incsearch' and |:match|.
  2820.     When you get bored looking at the highlighted matches, you can turn it
  2821.     off with |:nohlsearch|.  As soon as you use a search command, the
  2822.     highlighting comes back.
  2823.     When the search pattern can match an end-of-line, Vim will try to
  2824.     highlight all of the matched text.  However, this depends on where the
  2825.     search starts.  This will be the first line in the window or the first
  2826.     line below a closed fold.  A match in a previous line which is not
  2827.     drawn may not continue in an newly drawn line.
  2828.     NOTE: This option is reset when 'compatible' is set.
  2829.  
  2830.                         *'history'* *'hi'*
  2831. 'history' 'hi'        number    (Vim default: 20, Vi default: 0)
  2832.             global
  2833.             {not in Vi}
  2834.     A history of ":" commands, and a history of previous search patterns
  2835.     are remembered.  This option decides how many entries may be stored in
  2836.     each of these histories (see |cmdline-editing|).
  2837.     NOTE: This option is set to the Vi default value when 'compatible' is
  2838.     set and to the Vim default value when 'compatible' is reset.
  2839.  
  2840.                      *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
  2841. 'hkmap' 'hk'        boolean (default off)
  2842.             global
  2843.             {not in Vi}
  2844.             {only available when compiled with the |+rightleft|
  2845.             feature}
  2846.     When on, the keyboard is mapped for the Hebrew character set.
  2847.     Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
  2848.     toggle this option.  See |rileft.txt|.
  2849.     NOTE: This option is reset when 'compatible' is set.
  2850.  
  2851.                  *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
  2852. 'hkmapp' 'hkp'        boolean (default off)
  2853.             global
  2854.             {not in Vi}
  2855.             {only available when compiled with the |+rightleft|
  2856.             feature}
  2857.     When on, phonetic keyboard mapping is used.  'hkmap' must also be on.
  2858.     This is useful if you have a non-Hebrew keyboard.
  2859.     See |rileft.txt|.
  2860.     NOTE: This option is reset when 'compatible' is set.
  2861.  
  2862.                         *'icon'* *'noicon'*
  2863. 'icon'            boolean    (default off, on when title can be restored)
  2864.             global
  2865.             {not in Vi}
  2866.             {not available when compiled without the |+title|
  2867.             feature}
  2868.     When on, the icon text of the window will be set to the value of
  2869.     'iconstring' (if it is not empty), or to the name of the file
  2870.     currently being edited.  Only the last part of the name is used.
  2871.     Overridden by the 'iconstring' option.
  2872.     Only works if the terminal supports setting window icons (currently
  2873.     only X11 GUI and terminals with a non-empty 't_IS' option - these are
  2874.     Unix xterm and iris-ansi by default, where 't_IS' is taken from the
  2875.     builtin termcap).
  2876.     When Vim was compiled with HAVE_X11 defined, the original icon will be
  2877.     restored if possible |X11|. See |X11-icon| for changing the icon on
  2878.     X11.
  2879.  
  2880.                         *'iconstring'*
  2881. 'iconstring'        string    (default "")
  2882.             global
  2883.             {not in Vi}
  2884.             {not available when compiled without the |+title|
  2885.             feature}
  2886.     When this option is not empty, it will be used for the icon text of
  2887.     the window.  This happens only when the 'icon' option is on.
  2888.     Only works if the terminal supports setting window icon text
  2889.     (currently only X11 GUI and terminals with a non-empty 't_IS' option).
  2890.     Does not work for MS Windows.
  2891.     When Vim was compiled with HAVE_X11 defined, the original icon will be
  2892.     restored if possible |X11|.
  2893.     When this option contains printf-style '%' items, they will be
  2894.     expanded according to the rules used for 'statusline'.  See
  2895.     'titlestring' for example settings.
  2896.     {not available when compiled without the |+statusline| feature}
  2897.  
  2898.             *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
  2899. 'ignorecase' 'ic'    boolean    (default off)
  2900.             global
  2901.     Ignore case in search patterns.  Also used when searching in the tags
  2902.     file.
  2903.     Also see 'smartcase'.
  2904.     Can be overruled by using "\c" or "\C" in the pattern, see
  2905.     |/ignorecase|.
  2906.  
  2907.                         *'imactivatekey'* *'imak'*
  2908. 'imactivatekey' 'imak'    string (default "")
  2909.             global
  2910.             {not in Vi}
  2911.             {only available when compiled with |+xim| and
  2912.             |+GUI_GTK|}
  2913.     Specifies the key that your Input Method in X-Windows uses for
  2914.     activation.  When this is specified correctly, vim can fully control
  2915.     IM with 'imcmdline', 'iminsert' and 'imsearch'.
  2916.     You can't use this option to change the activation key, the option
  2917.     tells Vim what the key is.
  2918.     Format:
  2919.         [MODIFIER_FLAG-]KEY_STRING
  2920.  
  2921.     These characters can be used for MODIFIER_FLAG (case is ignored):
  2922.         S        Shift key
  2923.         L        Lock key
  2924.         C        Control key
  2925.         1        Mod1 key
  2926.         2        Mod2 key
  2927.         3        Mod3 key
  2928.         4        Mod4 key
  2929.         5        Mod5 key
  2930.     Combinations are allowed, for example "S-C-space" or "SC-space" are
  2931.     both shift+ctrl+space.
  2932.     See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
  2933.  
  2934.     Example: >
  2935.         :set imactivatekey=S-space
  2936. <    "S-space" means shift+space.  This is the activation key for kinput2 +
  2937.     canna (Japanese), and ami (Korean).
  2938.  
  2939.                 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
  2940. 'imcmdline' 'imc'    boolean (default off)
  2941.             global
  2942.             {not in Vi}
  2943.             {only available when compiled with the |+xim|
  2944.             |+multi_byte_ime| or |global-ime| feature}
  2945.     When set the Input Method is always on when starting to edit a command
  2946.     line, unless entering a search pattern (see 'imsearch' for that).
  2947.     Setting this option is useful when your input method allows entering
  2948.     English characters directly, e.g., when it's used to type accented
  2949.     characters with dead keys.
  2950.  
  2951.                 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
  2952. 'imdisable' 'imd'    boolean (default off, on for some systems (SGI))
  2953.             global
  2954.             {not in Vi}
  2955.             {only available when compiled with the |+xim|
  2956.             |+multi_byte_ime| or |global-ime| feature}
  2957.     When set the Input Method is never used.  This is useful to disable
  2958.     the IM when it doesn't work properly.
  2959.     Currently this option is on by default for SGI/IRIX machines.  This
  2960.     may change in later releases.
  2961.  
  2962.                         *'iminsert'* *'imi'*
  2963. 'iminsert' 'imi'    number (default 0, 2 when an input method is supported)
  2964.             local to buffer
  2965.             {not in Vi}
  2966.     Specifies whether :lmap or an Input Method (IM) is to be used in
  2967.     Insert mode.  Valid values:
  2968.         0    :lmap is off and IM is off
  2969.         1    :lmap is ON and IM is off
  2970.         2    :lmap is off and IM is ON
  2971.     2 is available only when compiled with the |+multi_byte_ime|, |+xim|
  2972.     or |global-ime|.
  2973.     To always reset the option to zero when leaving Insert mode with <Esc>
  2974.     this can be used: >
  2975.         :inoremap <ESC> <ESC>:set iminsert=0<CR>
  2976. <    This makes :lmap and IM turn off automatically when leaving Insert
  2977.     mode.
  2978.     Note that this option changes when using CTRL-^ in Insert mode
  2979.     |i_CTRL-^|.
  2980.     The value is set to 1 when defining a new |:lmap| mapping.
  2981.     It is also used for the argument of commands like "r" and "f".
  2982.     The value 0 may not work correctly with Athena and Motif with some XIM
  2983.     methods.  Use 'imdisable' to disable XIM then.
  2984.  
  2985.                         *'imsearch'* *'ims'*
  2986. 'imsearch' 'ims'    number (default 0, 2 when an input method is supported)
  2987.             local to buffer
  2988.             {not in Vi}
  2989.     Specifies whether :lmap or an Input Method (IM) is to be used when
  2990.     entering a search pattern.  Valid values:
  2991.         -1    the value of 'iminsert' is used, makes it look like
  2992.             'iminsert' is also used when typing a search pattern
  2993.         0    :lmap is off and IM is off
  2994.         1    :lmap is ON and IM is off
  2995.         2    :lmap is off and IM is ON
  2996.     Note that this option changes when using CTRL-^ in Insert mode
  2997.     |c_CTRL-^|.
  2998.     The value is set to 1 when defining a new |:lmap| mapping.
  2999.     The value 0 may not work correctly with Athena and Motif with some XIM
  3000.     methods.  Use 'imdisable' to disable XIM then.
  3001.  
  3002.                         *'include'* *'inc'*
  3003. 'include' 'inc'        string    (default "^#\s*include")
  3004.             global or local to buffer |global-local|
  3005.             {not in Vi}
  3006.             {not available when compiled without the
  3007.             |+find_in_path| feature}
  3008.     Pattern to be used to find an include command.  It is a search
  3009.     pattern, just like for the "/" command (See |pattern|).  The default
  3010.     value is for C programs.  This option is used for the commands "[i",
  3011.     "]I", "[d", etc..  The 'isfname' option is used to recognize the file
  3012.     name that comes after the matched pattern.  See |option-backslash|
  3013.     about including spaces and backslashes.
  3014.  
  3015.                         *'includeexpr'* *'inex'*
  3016. 'includeexpr' 'inex'    string    (default "")
  3017.             local to buffer
  3018.             {not in Vi}
  3019.             {not available when compiled without the
  3020.             |+find_in_path| or |+eval| feature}
  3021.     Expression to be used to transform the string found with the 'include'
  3022.     option to a file name.  Mostly useful to change "." to "/" for Java: >
  3023.         :set includeexpr=substitute(v:fname,'\\.','/','g')
  3024. <    The "v:fname" variable will be set to the file name that was detected.
  3025.     Evaluated in the |sandbox|.
  3026.     Also used for the |gf| command if an unmodified file name can't be
  3027.     found.  Allows doing "gf" on the name after an 'include' statement.
  3028.     Also used for |<cfile>|.
  3029.  
  3030.                  *'incsearch'* *'is'* *'noincsearch'* *'nois'*
  3031. 'incsearch' 'is'    boolean    (default off)
  3032.             global
  3033.             {not in Vi}
  3034.             {not available when compiled without the
  3035.             |+extra_search| feature}
  3036.     While typing a search pattern, show immediately where the so far
  3037.     typed pattern matches.  The matched string is highlighted.  If the
  3038.     pattern is invalid or not found, nothing is shown.  The screen will
  3039.     be updated often, this is only useful on fast terminals.  Note that
  3040.     the match will be shown, but the cursor is not actually positioned
  3041.     there.  You still need to finish the search command with <CR> to move
  3042.     the cursor.  The highlighting can be set with the 'i' flag in
  3043.     'highlight'.  See also: 'hlsearch'.
  3044.     NOTE: This option is reset when 'compatible' is set.
  3045.  
  3046.                         *'indentexpr'* *'inde'*
  3047. 'indentexpr' 'inde'    string    (default "")
  3048.             local to buffer
  3049.             {not in Vi}
  3050.             {not available when compiled without the |+cindent|
  3051.             or |+eval| features}
  3052.     Expression which is evaluated to obtain the proper indent for a line.
  3053.     It is used when a new line is created, for the |=| operator and
  3054.     in Insert mode as specified with the 'indentkeys' option.
  3055.     When this option is not empty, it overrules the 'cindent' and
  3056.     'smartindent' indenting.
  3057.     When 'paste' is set this option is not used for indenting.
  3058.     The expression is evaluated with |v:lnum| set to the line number for
  3059.     which the indent is to be computed.
  3060.     The expression must return the number of spaces worth of indent.  It
  3061.     can return "-1" to keep the current indent (this means 'autoindent' is
  3062.     used for the indent).
  3063.     Functions useful for computing the indent are |indent()|, |cindent()|
  3064.     and |lispindent()|.
  3065.     The evaluation of the expression must not have side effects!  It must
  3066.     not change the text, jump to another window, etc.  Afterwards the
  3067.     cursor position is always restored, thus the cursor may be moved.
  3068.     Normally this option would be set to call a function: >
  3069.         :set indentexpr=GetMyIndent()
  3070. <    Error messages will be surpressed, unless the 'debug' option contains
  3071.     "msg".
  3072.     See |indent-expression|.  Also see |eval-sandbox|.
  3073.     NOTE: This option is made empty when 'compatible' is set.
  3074.  
  3075.                         *'indentkeys'* *'indk'*
  3076. 'indentkeys' 'indk'    string    (default "0{,0},:,0#,!^F,o,O,e")
  3077.             local to buffer
  3078.             {not in Vi}
  3079.             {not available when compiled without the |+cindent|
  3080.             feature}
  3081.     A list of keys that, when typed in Insert mode, cause reindenting of
  3082.     the current line.  Only happens if 'indentexpr' isn't empty.
  3083.     The format is identical to 'cinkeys', see |indentkeys-format|.
  3084.     See |C-indenting| and |indent-expression|.
  3085.  
  3086.             *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
  3087. 'infercase' 'inf'    boolean    (default off)
  3088.             local to buffer
  3089.             {not in Vi}
  3090.     When doing keyword completion in insert mode |ins-completion|, and
  3091.     'ignorecase' is also on, the case of the match is adjusted.  If the
  3092.     typed text contains a lowercase letter where the match has an upper
  3093.     case letter, the completed part is made lowercase.  If the typed text
  3094.     has no lowercase letters and the match has a lowercase letter where
  3095.     the typed text has an uppercase letter, and there is a letter before
  3096.     it, the completed part is made uppercase.
  3097.  
  3098.             *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
  3099. 'insertmode' 'im'    boolean    (default off)
  3100.             global
  3101.             {not in Vi}
  3102.     Makes Vim work in a way that Insert mode is the default mode.  Useful
  3103.     if you want to use Vim as a modeless editor.  Used for |evim|.
  3104.     These Insert mode commands will be useful:
  3105.     - Use the cursor keys to move around.
  3106.     - Use CTRL-O to execute one Normal mode command |i_CTRL-O|).  When
  3107.       this is a mapping, it is executed as if 'insertmode' was off.
  3108.       Normal mode remains active until the mapping is finished.
  3109.                                 *i_CTRL-L*
  3110.     - Use CTRL-L to execute a number of Normal mode commands, then use
  3111.       <Esc> to get back to Insert mode.
  3112.  
  3113.     These items change when 'insertmode' is set:
  3114.     - when starting to edit of a file, Vim goes to Insert mode.
  3115.     - <Esc> in Insert mode is a no-op and beeps.
  3116.     - <Esc> in Normal mode makes Vim go to Insert mode.
  3117.     - CTRL-L in Insert mode is a command, it is not inserted.
  3118.     - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|.    *i_CTRL-Z*
  3119.     However, when <Esc> is used inside a mapping, it behaves like
  3120.     'insertmode' was not set.  This was done to be able to use the same
  3121.     mappings with 'insertmode' set or not set.
  3122.     When executing commands with |:normal| 'insertmode' is not used.
  3123.  
  3124.     NOTE: This option is reset when 'compatible' is set.
  3125.  
  3126.                         *'isfname'* *'isf'*
  3127. 'isfname' 'isf'        string    (default for MS-DOS, Win32 and OS/2:
  3128.                  "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
  3129.                 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
  3130.                 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
  3131.                 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
  3132.                 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
  3133.             global
  3134.             {not in Vi}
  3135.     The characters specified by this option are included in file names and
  3136.     path names.  Filenames are used for commands like "gf", "[i" and in
  3137.     the tags file.  It is also used for "\f" in a |pattern|.
  3138.     Characters that are defined by the C function isalpha() are also
  3139.     always included (this depends on the character set and "locale").
  3140.     Multi-byte characters 256 and above are always included, only the
  3141.     characters up to 255 are specified with this option.
  3142.     For UTF-8 the characters 0xa0 to 0xff are included as well.
  3143.  
  3144.     Note that on systems using a backslash as path separator, Vim tries to
  3145.     do its best to make it work as you would expect.  That is a bit
  3146.     tricky, since Vi originally used the backslash to escape special
  3147.     characters.  Vim on will not remove a backslash in front of a normal
  3148.     file name character on these systems, but it will on Unix and alikes.
  3149.     The '&' and '^' are not included by default, because these are special
  3150.     for cmd.exe.
  3151.  
  3152.     The format of this option is a list of parts, separated with commas.
  3153.     Each part can be a single character number or a range.  A range is two
  3154.     character numbers with '-' in between.  A character number can be a
  3155.     decimal number between 0 and 255 or the ASCII character itself (does
  3156.     not work for digits).  Example:
  3157.         "_,-,128-140,#-43"    (include '_' and '-' and the range
  3158.                     128 to 140 and '#' to 43)
  3159.     If a part starts with '^', the following character number or range
  3160.     will be excluded from the option.  The option is interpreted from left
  3161.     to right.  Put the excluded character after the range where it is
  3162.     included.  To include '^' itself use it as the last character of the
  3163.     option or the end of a range.  Example:
  3164.         "^a-z,#,^"    (exclude 'a' to 'z', include '#' and '^')
  3165.     If the character is '@', all characters where isalpha() returns TRUE
  3166.     are included.  Normally these are the characters a to z and A to Z,
  3167.     plus accented characters.  To include '@' itself use "@-@".  Examples:
  3168.         "@,^a-z"    All alphabetic characters, excluding lower
  3169.                 case letters.
  3170.         "a-z,A-Z,@-@"    All letters plus the '@' character.
  3171.     A comma can be included by using it where a character number is
  3172.     expected.  Example:
  3173.         "48-57,,,_"    Digits, command and underscore.
  3174.     A comma can be excluded by prepending a '^'.  Example:
  3175.         " -~,^,,9"    All characters from space to '~', excluding
  3176.                 comma, plus <Tab>.
  3177.     See |option-backslash| about including spaces and backslashes.
  3178.  
  3179.                         *'isident'* *'isi'*
  3180. 'isident' 'isi'        string    (default for MS-DOS, Win32 and OS/2:
  3181.                        "@,48-57,_,128-167,224-235"
  3182.                 otherwise: "@,48-57,_,192-255")
  3183.             global
  3184.             {not in Vi}
  3185.     The characters given by this option are included in identifiers.
  3186.     Identifiers are used in recognizing environment variables and after a
  3187.     match of the 'define' option.  It is also used for "\i" in a
  3188.     |pattern|. See 'isfname' for a description of the format of this
  3189.     option.
  3190.     Careful: If you change this option, it might break expanding
  3191.     environment variables.  E.g., when '/' is included and Vim tries to
  3192.     expand "$HOME/.viminfo".  Maybe you should change 'iskeyword' instead.
  3193.  
  3194.                         *'iskeyword'* *'isk'*
  3195. 'iskeyword' 'isk'    string (Vim default for MS-DOS and Win32:
  3196.                         "@,48-57,_,128-167,224-235"
  3197.                    otherwise:  "@,48-57,_,192-255"
  3198.                 Vi default: "@,48-57,_")
  3199.             local to buffer
  3200.             {not in Vi}
  3201.     Keywords are used in searching and recognizing with many commands:
  3202.     "w", "*", "[i", etc.  It is also used for "\k" in a |pattern|.  See
  3203.     'isfname' for a description of the format of this option.  For C
  3204.     programs you could use "a-z,A-Z,48-57,_,.,-,>".
  3205.     For a help file it is set to all non-blank printable characters except
  3206.     '*', '"' and '|' (so that CTRL-] on a command finds the help for that
  3207.     command).
  3208.     When the 'lisp' option is on the '-' character is always included.
  3209.     NOTE: This option is set to the Vi default value when 'compatible' is
  3210.     set and to the Vim default value when 'compatible' is reset.
  3211.  
  3212.                         *'isprint'* *'isp'*
  3213. 'isprint' 'isp'    string    (default for MS-DOS, Win32, OS/2 and Macintosh:
  3214.                 "@,~-255"; otherwise: "@,161-255")
  3215.             global
  3216.             {not in Vi}
  3217.     The characters given by this option are displayed directly on the
  3218.     screen.  It is also used for "\p" in a |pattern|.  The characters from
  3219.     space (ascii 32) to '~' (ascii 126) are always displayed directly,
  3220.     even when they are not included in 'isprint' or excluded.  See
  3221.     'isfname' for a description of the format of this option.
  3222.  
  3223.     Non-printable characters are displayed with two characters:
  3224.           0 -  31    "^@" - "^_"
  3225.          32 - 126    always single characters
  3226.            127        "^?"
  3227.         128 - 159    "~@" - "~_"
  3228.         160 - 254    "| " - "|~"
  3229.            255        "~?"
  3230.     When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
  3231.     displayed as <xx>, with the hexadecimal value of the byte.
  3232.     When 'display' contains "uhex" all unprintable characters are
  3233.     displayed as <xx>.
  3234.     The NonText highlighting will be used for unprintable characters.
  3235.     |hl-NonText|
  3236.  
  3237.     Multi-byte characters 256 and above are always included, only the
  3238.     characters up to 255 are specified with this option.  When a character
  3239.     is printable but it is not available in the current font, a
  3240.     replacement character will be shown.
  3241.     Unprintable and zero-width Unicode characters are displayed as <xxxx>.
  3242.     There is no option to specify these characters.
  3243.  
  3244.             *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
  3245. 'joinspaces' 'js'    boolean    (default on)
  3246.             global
  3247.             {not in Vi}
  3248.     Insert two spaces after a '.', '?' and '!' with a join command.
  3249.     When 'cpoptions' includes the 'j' flag, only do this after a '.'.
  3250.     Otherwise only one space is inserted.
  3251.     NOTE: This option is set when 'compatible' is set.
  3252.  
  3253.                             *'key'*
  3254. 'key'            string    (default "")
  3255.             local to buffer
  3256.             {not in Vi}
  3257.     The key that is used for encrypting and decrypting the current buffer.
  3258.     See |encryption|.
  3259.     Careful: Do not set the key value by hand, someone might see the typed
  3260.     key.  Use the |:X| command.  But you can make 'key' empty: >
  3261.         :set key=
  3262. <    It is not possible to get the value of this option with ":set key" or
  3263.     "echo &key".  This is to avoid showing it to someone who shouldn't
  3264.     know.  It also means you cannot see it yourself once you have set it,
  3265.     be careful not to make a typing error!
  3266.  
  3267.                     *'keymap'* *'kmp'*
  3268. 'keymap' 'kmp'        string    (default "")
  3269.             local to buffer
  3270.             {not in Vi}
  3271.             {only available when compiled with the |+keymap|
  3272.             feature}
  3273.     Name of a keyboard mapping.  See |mbyte-keymap|.
  3274.  
  3275.                     *'keymodel'* *'km'*
  3276. 'keymodel' 'km'        string    (default "")
  3277.             global
  3278.             {not in Vi}
  3279.     List of comma separated words, which enable special things that keys
  3280.     can do.  These values can be used:
  3281.        startsel    Using a shifted special key starts selection (either
  3282.             Select mode or Visual mode, depending on "key" being
  3283.             present in 'selectmode').
  3284.        stopsel    Using a not-shifted special key stops selection.
  3285.     Special keys in this context are the cursor keys, <End>, <Home>,
  3286.     <PageUp> and <PageDown>.
  3287.     The 'keymodel' option is set by the |:behave| command.
  3288.  
  3289.                     *'keywordprg'* *'kp'*
  3290. 'keywordprg' 'kp'    string    (default "man" or "man -s",  DOS: "",
  3291.                         OS/2: "view /", VMS: "help")
  3292.             global
  3293.             {not in Vi}
  3294.     Program to use for the |K| command.  Environment variables are
  3295.     expanded |:set_env|.  When empty ":help" is used.
  3296.     When "man" is used, Vim will automatically translate a count for the
  3297.     "K" command to a section number.  Also for "man -s", in which case the
  3298.     "-s" is removed when there is no count.
  3299.     See |option-backslash| about including spaces and backslashes.
  3300.     Example: >
  3301.         :set keywordprg=man\ -s
  3302. <    This option cannot be set from a |modeline|, for security reasons.
  3303.  
  3304.                     *'langmap'* *'lmap'* *E357* *E358*
  3305. 'langmap' 'lmap'    string    (default "")
  3306.             global
  3307.             {not in Vi}
  3308.             {only available when compiled with the |+langmap|
  3309.             feature}
  3310.     This option allows switching your keyboard into a special language
  3311.     mode.   When you are typing text in Insert mode the characters are
  3312.     inserted directly.  When in command mode the 'langmap' option takes
  3313.     care of translating these special characters to the original meaning
  3314.     of the key.  This means you don't have to change the keyboard mode to
  3315.     be able to execute Normal mode commands.
  3316.     This is the opposite of the 'keymap' option, where characters are
  3317.     mapped in Insert mode.
  3318.     This only works for 8-bit characters.  The value of 'langmap' may be
  3319.     specified with multi-byte characters (e.g., UTF-8), but only the lower
  3320.     8 bits of each character will be used.
  3321.  
  3322.     Example (for Greek):                    *greek*  >
  3323.         :set langmap=ÁA,ÂB,ØC,ÄD,ÅE,ÖF,ÃG,ÇH,ÉI,ÎJ,ÊK,ËL,ÌM,ÍN,ÏO,ÐP,QQ,ÑR,ÓS,ÔT,ÈU,ÙV,WW,×X,ÕY,ÆZ,áa,âb,øc,äd,åe,öf,ãg,çh,éi,îj,êk,ël,ìm,ín,ïo,ðp,qq,ñr,ós,ôt,èu,ùv,òw,÷x,õy,æz
  3324. <    Example (exchanges meaning of z and y for commands): >
  3325.         :set langmap=zy,yz,ZY,YZ
  3326. <
  3327.     The 'langmap' option is a list of parts, separated with commas.  Each
  3328.     part can be in one of two forms:
  3329.     1.  A list of pairs.  Each pair is a "from" character immediately
  3330.         followed by the "to" character.  Examples: "aA", "aAbBcC".
  3331.     2.  A list of "from" characters, a semi-colon and a list of "to"
  3332.         characters.  Example: "abc;ABC"
  3333.     Example: "aA,fgh;FGH,cCdDeE"
  3334.     Special characters need to be preceded with a backslash.  These are
  3335.     ";", ',' and backslash itself.
  3336.  
  3337.     This will allow you to activate vim actions without having to switch
  3338.     back and forth between the languages.  Your language characters will
  3339.     be understood as normal vim English characters (according to the
  3340.     langmap mappings) in the following cases:
  3341.      o Normal/Visual mode (commands, buffer/register names, user mappings)
  3342.      o Insert/Replace Mode: Register names after CTRL-R
  3343.      o Insert/Replace Mode: Mappings
  3344.     Characters entered in Command-line mode will NOT be affected by
  3345.     this option.   Note that this option can be changed at any time
  3346.     allowing to switch between mappings for different languages/encodings.
  3347.     Use a mapping to avoid having to type it each time!
  3348.  
  3349.                     *'langmenu'* *'lm'*
  3350. 'langmenu' 'lm'        string    (default "")
  3351.             global
  3352.             {not in Vi}
  3353.             {only available when compiled with the |+menu| and
  3354.             |+multi_lang| features}
  3355.     Language to use for menu translation.  Tells which file is loaded
  3356.     from the "lang" directory in 'runtimepath': >
  3357.         "lang/menu_" . &langmenu . ".vim"
  3358. <    (without the spaces).  For example, to always use the Dutch menus, no
  3359.     matter what $LANG is set to: >
  3360.         :set langmenu=nl_NL.ISO_8859-1
  3361. <    When 'langmenu' is empty, |v:lang| is used.
  3362.     If your $LANG is set to a non-English language but you do want to use
  3363.     the English menus: >
  3364.         :set langmenu=none
  3365. <    This option must be set before loading menus, switching on filetype
  3366.     detection or syntax highlighting.  Once the menus are defined setting
  3367.     this option has no effect.  But you could do this: >
  3368.         :source $VIMRUNTIME/delmenu.vim
  3369.         :set langmenu=de_DE.ISO_8859-1
  3370.         :source $VIMRUNTIME/menu.vim
  3371. <    Warning: This deletes all menus that you defined yourself!
  3372.  
  3373.                     *'laststatus'* *'ls'*
  3374. 'laststatus' 'ls'    number    (default 1)
  3375.             global
  3376.             {not in Vi}
  3377.     The value of this option influences when the last window will have a
  3378.     status line:
  3379.         0: never
  3380.         1: only if there are at least two windows
  3381.         2: always
  3382.     The screen looks nicer with a status line if you have several
  3383.     windows, but it takes another screen line. |status-line|
  3384.  
  3385.             *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
  3386. 'lazyredraw' 'lz'    boolean    (default off)
  3387.             global
  3388.             {not in Vi}
  3389.     When this option is set, the screen will not be redrawn while
  3390.     executing macros, registers and other commands that have not been
  3391.     typed.  To force an update use |:redraw|.
  3392.  
  3393.             *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
  3394. 'linebreak' 'lbr'    boolean    (default off)
  3395.             local to window
  3396.             {not in Vi}
  3397.             {not available when compiled without the  |+linebreak|
  3398.             feature}
  3399.     If on Vim will wrap long lines at a character in 'breakat' rather
  3400.     than at the last character that fits on the screen.  Unlike
  3401.     'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
  3402.     it only affects the way the file is displayed, not its contents.  The
  3403.     value of 'showbreak' is used to put in front of wrapped lines.  This
  3404.     option is not used when the 'wrap' option is off or 'list' is on.
  3405.     Note that <Tab> characters after an <EOL> are mostly not displayed
  3406.     with the right amount of white space.
  3407.  
  3408.                         *'lines'*
  3409. 'lines'            number    (default 24 or terminal height)
  3410.             global
  3411.     Number of lines in the display.  Normally you don't need to set this.
  3412.     That is done automatically by the terminal initialization code.
  3413.     When Vim is running in the GUI or in a resizable window, setting this
  3414.     option may cause the window size to be changed.
  3415.     When you set this option and Vim is unable to change the physical
  3416.     number of lines of the display, the display may be messed up.
  3417.  
  3418.                         *'linespace'* *'lsp'*
  3419. 'linespace' 'lsp'    number    (default 0, 1 for Win32 GUI)
  3420.             global
  3421.             {not in Vi}
  3422.             {only in the GUI}
  3423.     Number of pixel lines inserted between characters.  Useful if the font
  3424.     uses the full character cell height, making lines touch each other.
  3425.     When non-zero there is room for underlining.
  3426.  
  3427.                         *'lisp'* *'nolisp'*
  3428. 'lisp'            boolean    (default off)
  3429.             local to buffer
  3430.             {not available when compiled without the |+lispindent|
  3431.             feature}
  3432.     Lisp mode: When <Enter> is typed in insert mode set the indent for
  3433.     the next line to Lisp standards (well, sort of).  Also happens with
  3434.     "cc" or "S".  'autoindent' must also be on for this to work.  The 'p'
  3435.     flag in 'cpoptions' changes the method of indenting: Vi compatible or
  3436.     better.  Also see 'lispwords'.
  3437.     The '-' character is included in keyword characters.  Redefines the
  3438.     "=" operator to use this same indentation algorithm rather than
  3439.     calling an external program if 'equalprg' is empty.
  3440.     This option is not used when 'paste' is set.
  3441.     {Vi: Does it a little bit differently}
  3442.  
  3443.                         *'lispwords'* *'lw'*
  3444. 'lispwords' 'lw'    string    (default is very long)
  3445.             global
  3446.             {not in Vi}
  3447.             {not available when compiled without the |+lispindent|
  3448.             feature}
  3449.     Comma separated list of words that influence the Lisp indenting.
  3450.  
  3451.                         *'list'* *'nolist'*
  3452. 'list'            boolean    (default off)
  3453.             local to window
  3454.     List mode: Show tabs as CTRL-I, show end of line with $.  Useful to
  3455.     see the difference between tabs and spaces and for trailing blanks.
  3456.     Note that this will also affect formatting (set with 'textwidth' or
  3457.     'wrapmargin') when 'cpoptions' includes 'L'.  See 'listchars' for
  3458.     changing the way tabs are displayed.
  3459.  
  3460.                         *'listchars'* *'lcs'*
  3461. 'listchars' 'lcs'    string    (default "eol:$")
  3462.             global
  3463.             {not in Vi}
  3464.     Strings to use in 'list' mode.  It is a comma separated list of string
  3465.     settings.
  3466.       eol:c        Character to show at the end of each line.  When
  3467.             omitted, there is no extra character at the end of the
  3468.             line.
  3469.       tab:xy    Two characters to be used to show a Tab.  The first
  3470.             char is used once.  The second char is repeated to
  3471.             fill the space that the Tab normally occupies.
  3472.             "tab:>-" will show a Tab that takes four spaces as
  3473.             ">---".  When omitted, a Tab is show as ^I.
  3474.       trail:c    Character to show for trailing spaces.  When omitted,
  3475.             trailing spaces are blank.
  3476.       extends:c    Character to show in the last column, when 'wrap' is
  3477.             off and the line continues beyond the right of the
  3478.             screen.
  3479.       precedes:c    Character to show in the first column, when 'wrap'
  3480.             is off and there is text preceeding the character
  3481.             visible in the first column.
  3482.  
  3483.     The characters ':' and ',' cannot be used.
  3484.     Examples: >
  3485.         :set lcs=tab:>-,trail:-
  3486.         :set lcs=tab:>-,eol:<
  3487.         :set lcs=extends:>,precedes:<
  3488. <    The "NonText" highlighting will be used for "eol", "extends" and
  3489.     "precedes".  "SpecialKey" for "tab" and "trail".
  3490.  
  3491.             *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
  3492. 'loadplugins' 'lpl'    boolean    (default on)
  3493.             global
  3494.             {not in Vi}
  3495.     When on the plugin scripts are loaded when starting up |load-plugins|.
  3496.     This option can be reset in your |vimrc| file to disable the loading
  3497.     of plugins.
  3498.     Note that using the "-u NONE" and "--noplugin" command line arguments
  3499.     reset this option. |-u| |--noplugin|
  3500.  
  3501.                         *'magic'* *'nomagic'*
  3502. 'magic'            boolean    (default on)
  3503.             global
  3504.     Changes the special characters that can be used in search patterns.
  3505.     See |pattern|.
  3506.     NOTE: To avoid portability problems with using patterns, always keep
  3507.     this option at the default "on".  Only switch it off when working with
  3508.     old Vi scripts.  In any other situation write patterns that work when
  3509.     'magic' is on.
  3510.  
  3511.                         *'makeef'* *'mef'*
  3512. 'makeef' 'mef'        string    (default: "")
  3513.             global
  3514.             {not in Vi}
  3515.             {not available when compiled without the |+quickfix|
  3516.             feature}
  3517.     Name of the errorfile for the |:make| command (see |:make_makeprg|)
  3518.     and the |:grep| command.
  3519.     When it is empty, an internally generated temp file will be used.
  3520.     When "##" is included, it is replaced by a number to make the name
  3521.     unique.  This makes sure that the ":make" command doesn't overwrite an
  3522.     existing file.
  3523.     NOT used for the ":cf" command.  See 'errorfile' for that.
  3524.     Environment variables are expanded |:set_env|.
  3525.     See |option-backslash| about including spaces and backslashes.
  3526.     This option cannot be set from a |modeline|, for security reasons.
  3527.  
  3528.                         *'makeprg'* *'mp'*
  3529. 'makeprg' 'mp'        string    (default "make", VMS: "MMS")
  3530.             global or local to buffer |global-local|
  3531.             {not in Vi}
  3532.     Program to use for the ":make" command.  See |:make_makeprg|.  This
  3533.     option may contain '%' and '#' characters, which are expanded like
  3534.     when used in a command-line.  Environment variables are expanded
  3535.     |:set_env|.  See |option-backslash| about including spaces and
  3536.     backslashes.  Note that a '|' must be escaped twice: once for ":set"
  3537.     and once for the interpretation of a command.  When you use a filter
  3538.     called "myfilter" do it like this: >
  3539.         :set makeprg=gmake\ \\\|\ myfilter
  3540. <    The placeholder "$*" can be given (even multiple times) to specify
  3541.     where the arguments will be included, for example: >
  3542.         :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  3543. <    This option cannot be set from a |modeline|, for security reasons.
  3544.  
  3545.                         *'matchpairs'* *'mps'*
  3546. 'matchpairs' 'mps'    string    (default "(:),{:},[:]")
  3547.             local to buffer
  3548.             {not in Vi}
  3549.     Characters that form pairs.  The |%| command jumps from one to the
  3550.     other.  Currently only single character pairs are allowed, and they
  3551.     must be different.  The characters must be separated by a colon.  The
  3552.     pairs must be separated by a comma.  Example for including '<' and '>'
  3553.     (HTML): >
  3554.         :set mps+=<:>
  3555.  
  3556. <    A more exotic example, to jump between the '=' and ';' in an
  3557.     assignment, useful for languages like C and Java: >
  3558.         :au FileType c,cpp,java set mps+==:;
  3559.  
  3560. <    For a more advanced way of using "%", see the matchit.vim plugin in
  3561.     the $VIMRUNTIME/macros directory. |add-local-help|
  3562.  
  3563.                         *'matchtime'* *'mat'*
  3564. 'matchtime' 'mat'    number    (default 5)
  3565.             global
  3566.             {not in Vi}{in Nvi}
  3567.     Tenths of a second to show the matching paren, when 'showmatch' is
  3568.     set.  Note that this is not in milliseconds, like other options that
  3569.     set a time.  This is to be compatible with Nvi.
  3570.  
  3571.                         *'maxfuncdepth'* *'mfd'*
  3572. 'maxfuncdepth' 'mfd'    number    (default 100)
  3573.             global
  3574.             {not in Vi}
  3575.     Maximum depth of function calls for user functions.  This normally
  3576.     catches endless recursion.  When using a recursive function with
  3577.     more depth, set 'maxfuncdepth' to a bigger number.  But this will use
  3578.     more memory, there is the danger of failing when memory is exhausted.
  3579.     See also |:function|.
  3580.  
  3581.                         *'maxmapdepth'* *'mmd'* *E223*
  3582. 'maxmapdepth' 'mmd'    number    (default 1000)
  3583.             global
  3584.             {not in Vi}
  3585.     Maximum number of times a mapping is done without resulting in a
  3586.     character to be used.  This normally catches endless mappings, like
  3587.     ":map x y" with ":map y x".  It still does not catch ":map g wg",
  3588.     because the 'w' is used before the next mapping is done.  See also
  3589.     |key-mapping|.
  3590.  
  3591.                         *'maxmem'* *'mm'*
  3592. 'maxmem' 'mm'        number    (default between 256 to 5120 (system
  3593.                  dependent) or half the amount of memory
  3594.                  available)
  3595.             global
  3596.             {not in Vi}
  3597.     Maximum amount of memory (in Kbyte) to use for one buffer.  When this
  3598.     limit is reached allocating extra memory for a buffer will cause
  3599.     other memory to be freed.  Maximum value 2000000.  Use this to work
  3600.     without a limit.  Also see 'maxmemtot'.
  3601.  
  3602.                         *'maxmemtot'* *'mmt'*
  3603. 'maxmemtot' 'mmt'    number    (default between 2048 and 10240 (system
  3604.                  dependent) or half the amount of memory
  3605.                  available)
  3606.             global
  3607.             {not in Vi}
  3608.     Maximum amount of memory (in Kbyte) to use for all buffers together.
  3609.     Maximum value 2000000.  Use this to work without a limit.  Also see
  3610.     'maxmem'.
  3611.  
  3612.                         *'menuitems'* *'mis'*
  3613. 'menuitems' 'mis'    number    (default 25)
  3614.             global
  3615.             {not in Vi}
  3616.             {not available when compiled without the |+menu|
  3617.             feature}
  3618.     Maximum number of items to use in a menu.  Used for menus that are
  3619.     generated from a list of items, e.g., the Buffers menu.  Changing this
  3620.     option has no direct effect, the menu must be refreshed first.
  3621.  
  3622.                    *'modeline'* *'ml'* *'nomodeline'* *'noml'*
  3623. 'modeline' 'ml'        boolean    (Vim default: on, Vi default: off)
  3624.             local to buffer
  3625.                         *'modelines'* *'mls'*
  3626. 'modelines' 'mls'    number    (default 5)
  3627.             global
  3628.             {not in Vi}
  3629.     If 'modeline' is on 'modelines' gives the number of lines that is
  3630.     checked for set commands.  If 'modeline' is off or 'modelines' is zero
  3631.     no lines are checked.  See |modeline|.
  3632.     NOTE: 'modeline' is set to the Vi default value when 'compatible' is
  3633.     set and to the Vim default value when 'compatible' is reset.
  3634.  
  3635.                 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
  3636. 'modifiable' 'ma'    boolean    (default on)
  3637.             local to buffer
  3638.             {not in Vi}        *E21*
  3639.     When off the buffer contents cannot be changed.  The 'fileformat' and
  3640.     'fileencoding' options also can't be changed.
  3641.     Can be reset with the |-M| command line argument.
  3642.  
  3643.                 *'modified'* *'mod'* *'nomodified'* *'nomod'*
  3644. 'modified' 'mod'    boolean    (default off)
  3645.             local to buffer
  3646.             {not in Vi}
  3647.     When on, the buffer is considered to be modified.  This option is set
  3648.     when:
  3649.     1. A change was made to the text since it was last written.  Using the
  3650.        |undo| command to go back to the original text will reset the
  3651.        option.  But undoing changes that were made before writing the
  3652.        buffer will set the option again, since the text is different from
  3653.        when it was written.
  3654.     2. 'fileformat' or 'fileencoding' is different from its original
  3655.        value.  The original value is set when the buffer is read or
  3656.        written.  A ":set nomodified" command also resets the original
  3657.        values to the current values and the 'modified' option will be
  3658.        reset.
  3659.     When 'buftype' is "nowrite" or "nofile" this option may be set, but
  3660.     will be ignored.
  3661.  
  3662.                         *'more'* *'nomore'*
  3663. 'more'            boolean    (Vim default: on, Vi default: off)
  3664.             global
  3665.             {not in Vi}
  3666.     When on, listings pause when the whole screen is filled.  You will get
  3667.     the |more-prompt|.  When this option is off there are no pauses, the
  3668.     listing continues until finished.
  3669.     NOTE: This option is set to the Vi default value when 'compatible' is
  3670.     set and to the Vim default value when 'compatible' is reset.
  3671.  
  3672.                         *'mouse'*
  3673. 'mouse'            string    (default "", "a" for GUI, MS-DOS and Win32)
  3674.             global
  3675.             {not in Vi}
  3676.     Enable the use of the mouse.  Only works for certain terminals
  3677.     (xterm, MS-DOS, Win32 |win32-mouse|, qnx pterm, and Linux console
  3678.     with gpm).  For using the mouse in the GUI, see |gui-mouse|.
  3679.     The mouse can be enabled for different modes:
  3680.         n    Normal mode
  3681.         v    Visual mode
  3682.         i    Insert mode
  3683.         c    Command-line mode
  3684.         h    all previous modes when editing a help file
  3685.         a    all previous modes
  3686.         r    for |hit-enter| and |more-prompt| prompt
  3687.     Normally you would enable the mouse in all four modes with: >
  3688.         :set mouse=a
  3689. <    When the mouse is not enabled, the GUI will still use the mouse for
  3690.     modeless selection.  This doesn't move the text cursor.
  3691.  
  3692.     See |mouse-using|.  Also see |'clipboard'|.
  3693.  
  3694.     Note: When enabling the mouse in a terminal, copy/paste will use the
  3695.     "* register if there is access to an X-server.  The xterm handling of
  3696.     the mouse buttons can still be used by keeping the shift key pressed.
  3697.     Also see the 'clipboard' option.
  3698.  
  3699.             *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
  3700. 'mousefocus' 'mousef'    boolean    (default off)
  3701.             global
  3702.             {not in Vi}
  3703.             {only works in the GUI}
  3704.     The window that the mouse pointer is on is automatically activated.
  3705.     When changing the window layout or window focus in another way, the
  3706.     mouse pointer is moved to the window with keyboard focus.  Off is the
  3707.     default because it makes using the pull down menus a little goofy, as
  3708.     a pointer transit may activate a window unintentionally.
  3709.  
  3710.             *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
  3711. 'mousehide' 'mh'    boolean    (default on
  3712.             global
  3713.             {not in Vi}
  3714.             {only works in the GUI}
  3715.     When on, the mouse pointer is hidden when characters are typed.
  3716.     The mouse pointer is restored when the mouse is moved.
  3717.  
  3718.                         *'mousemodel'* *'mousem'*
  3719. 'mousemodel' 'mousem'    string    (default "extend", "popup" for MS-DOS and Win32)
  3720.             global
  3721.             {not in Vi}
  3722.     Sets the model to use for the mouse.  The name mostly specifies what
  3723.     the right mouse button is used for:
  3724.        extend    Right mouse button extends a selection.  This works
  3725.             like in an xterm.
  3726.        popup    Right mouse button pops up a menu.  The shifted left
  3727.             mouse button extends a selection.  This works like
  3728.             with Microsoft Windows
  3729.        popup_setpos Like "popup", but the cursor will be moved to the
  3730.             position where the mouse was clicked, and thus the
  3731.             selected operation will act upon the clicked object.
  3732.             If clicking inside a selection, that selection will
  3733.             be acted upon, ie. no cursor move.  This implies of
  3734.             course, that right clicking outside a selection will
  3735.             end Visual mode.
  3736.     Overview of what button does what for each model:
  3737.     mouse            extend        popup(_setpos) ~
  3738.     left click        place cursor    place cursor
  3739.     left drag        start selection    start selection
  3740.     shift-left        search word        extend selection
  3741.     right click        extend selection    popup menu (place cursor)
  3742.     right drag        extend selection    -
  3743.     middle click        paste        paste
  3744.  
  3745.     In the "popup" model the right mouse button produces a pop-up menu.
  3746.     You need to define this first, see |popup-menu|.
  3747.  
  3748.     Note that you can further refine the meaning of buttons with mappings.
  3749.     See |gui-mouse-mapping|.  But mappings are NOT used for modeless
  3750.     selection (because that's handled in the GUI code directly).
  3751.  
  3752.     The 'mousemodel' option is set by the |:behave| command.
  3753.  
  3754.                         *'mouseshape'* *'mouses'*
  3755. 'mouseshape' 'mouses'    string    (default "i:beam,r:beam,s:updown,sd:cross,
  3756.                     m:no,v:rightup-arrow"
  3757.             global
  3758.             {not in Vi}
  3759.             {only available when compiled with the |+mouseshape|
  3760.             feature}
  3761.     This option tells Vim what the mouse pointer should look like in
  3762.     different modes.  The option is a comma separated list of parts, much
  3763.     like used for 'guicursor'.  Each part consist of a mode/location-list
  3764.     and an argument-list:
  3765.         mode-list:shape,mode-list:shape,..
  3766.     The mode-list is a dash separated list of these modes/locations:
  3767.             In a normal window: ~
  3768.         n    Normal mode
  3769.         v    Visual mode
  3770.         ve    Visual mode with 'selection' "exclusive" (same as 'v',
  3771.             if not specified)
  3772.         o    Operator-pending mode
  3773.         i    Insert mode
  3774.         r    Replace mode
  3775.  
  3776.             Others: ~
  3777.         c    appending to the command-line
  3778.         ci    inserting in the command-line
  3779.         cr    replacing in the command-line
  3780.         m    At the 'Hit ENTER' or 'More' prompts
  3781.         e    any mode, pointer below last window
  3782.         s    any mode, pointer on a status line
  3783.         sd    any mode, while dragging a status line
  3784.         vs    any mode, pointer on a vertical separator line
  3785.         vd    any mode, while dragging a vertical separator line
  3786.         a    everywhere
  3787.  
  3788.     The shape is one of the following:
  3789.     avail    name        looks like ~
  3790.     w x    arrow        Normal mouse pointer
  3791.     w x    blank        no pointer at all (use with care!)
  3792.     w x    beam        I-beam
  3793.     w x    updown        up-down sizing arrows
  3794.     w x    leftright    left-right sizing arrows
  3795.     w x    busy        The system's usual busy pointer
  3796.     w x    no        The system's usual 'no input' pointer
  3797.       x    udsizing    indicates up-down resizing
  3798.       x    lrsizing    indicates left-right resizing
  3799.       x    crosshair    like a big thin +
  3800.       x    hand1        white hand
  3801.       x    hand2        black hand
  3802.       x    pencil        what you write with
  3803.       x    question    big ?
  3804.       x    rightup-arrow    arrow pointing right-up
  3805.     w x    up-arrow    arrow pointing up
  3806.       x    <number>    any X11 pointer number (see X11/cursorfont.h)
  3807.  
  3808.     The "avail" column contains a 'w' if the shape is available for Win32,
  3809.     x for X11.
  3810.     Any modes not specifed or shapes not available use the normal mouse
  3811.     pointer.
  3812.  
  3813.     Example: >
  3814.         :set mouseshape=s:size,m:no
  3815. <    will make the mouse turn to a sizing arrow over the status lines and
  3816.     indicate no input when the hit-enter prompt is displayed (since
  3817.     clicking the mouse has no effect in this state.)
  3818.  
  3819.                         *'mousetime'* *'mouset'*
  3820. 'mousetime' 'mouset'    number    (default 500)
  3821.             global
  3822.             {not in Vi}
  3823.     Only for GUI, MS-DOS, Win32 and Unix with xterm.  Defines the maximum
  3824.     time in msec between two mouse clicks for the second click to be
  3825.     recognized as a multi click.
  3826.  
  3827.                             *'nrformats'* *'nf'*
  3828. 'nrformats' 'nf'    string    (default "octal,hex")
  3829.             local to buffer
  3830.             {not in Vi}
  3831.     This defines what bases Vim will consider for numbers when using the
  3832.     CTRL-A and CTRL-X commands for adding to and subtracting from a number
  3833.     respectively; see |CTRL-A| for more info on these commands.
  3834.     alpha    if included, single alphabetical characters will be
  3835.         incremented or decremented.  This is useful for a list with a
  3836.         letter index a), b), etc.
  3837.     octal    if included, numbers that start with a zero will be considered
  3838.         to be octal.  Example: Using CTRL-A on "007" results in "010".
  3839.     hex    if included, numbers starting with "0x" or "0X" will be
  3840.         considered to be hexadecimal.  Example: Using CTRL-X on
  3841.         "0x100" results in "0x0ff".
  3842.     Numbers which simply begin with a digit in the range 1-9 are always
  3843.     considered decimal.  This also happens for numbers that are not
  3844.     recognized as octal or hex.
  3845.  
  3846.                 *'number'* *'nu'* *'nonumber'* *'nonu'*
  3847. 'number' 'nu'        boolean    (default off)
  3848.             local to window
  3849.     Print the line number in front of each line.  When the 'n' option is
  3850.     excluded from 'cpoptions' a wrapped line will not use the column of
  3851.     line numbers (this is the default when 'compatible' isn't set).
  3852.     When a long, wrapped line doesn't start with the first character, '-'
  3853.     characters are put before the number.
  3854.     See |hl-LineNr| for the highlighting used for the number.
  3855.  
  3856.                     *'osfiletype'* *'oft'* *E366*
  3857. 'osfiletype' 'oft'    string (RISC-OS default: "Text",
  3858.                 others default: "")
  3859.             local to buffer
  3860.             {not in Vi}
  3861.             {only available when compiled with the |+osfiletype|
  3862.             feature}
  3863.     Some operating systems store extra information about files besides
  3864.     name, datestamp and permissions.  This option contains the extra
  3865.     information, the nature of which will vary between systems.
  3866.     The value of this option is usually set when the file is loaded, and
  3867.     use to set the file type when file is written.
  3868.     It can affect the pattern matching of the automatic commands.
  3869.     |autocmd-osfiletypes|
  3870.  
  3871.                         *'paragraphs'* *'para'*
  3872. 'paragraphs' 'para'    string    (default "IPLPPPQPP LIpplpipbp")
  3873.             global
  3874.     Specifies the nroff macros that separate paragraphs.  These are pairs
  3875.     of two letters (see |object-motions|).
  3876.  
  3877.                         *'paste'* *'nopaste'*
  3878. 'paste'            boolean    (default off)
  3879.             global
  3880.             {not in Vi}
  3881.     Put Vim in Paste mode.  This is useful if you want to cut or copy
  3882.     some text from one window and paste it in Vim.  This will avoid
  3883.     unexpected effects.
  3884.     Setting this option is useful when using Vim in a terminal, where Vim
  3885.     cannot distinguish between typed text and pasted text.  In the GUI, Vim
  3886.     knows about pasting and will mostly do the right thing without 'paste'
  3887.     being set.  The same is true for a terminal where Vim handles the
  3888.     mouse clicks itself.
  3889.     When the 'paste' option is switched on (also when it was already on):
  3890.         - mapping in Insert mode and Command-line mode is disabled
  3891.         - abbreviations are disabled
  3892.         - 'textwidth' is set to 0
  3893.         - 'wrapmargin' is set to 0
  3894.         - 'autoindent' is reset
  3895.         - 'smartindent' is reset
  3896.         - 'softtabstop' is set to 0
  3897.         - 'revins' is reset
  3898.         - 'ruler' is reset
  3899.         - 'showmatch' is reset
  3900.         - 'formatoptions' is used like it is empty
  3901.     These options keep their value, but their effect is disabled:
  3902.         - 'lisp'
  3903.         - 'indentexpr'
  3904.         - 'cindent'
  3905.     NOTE: When you start editing another file while the 'paste' option is
  3906.     on, settings from the modelines or autocommands may change the
  3907.     settings again, causing trouble when pasting text.  You might want to
  3908.     set the 'paste' option again.
  3909.     When the 'paste' option is reset the mentioned options are restored to
  3910.     the value before the moment 'paste' was switched from off to on.
  3911.     Resetting 'paste' before ever setting it does not have any effect.
  3912.     Since mapping doesn't work while 'paste' is active, you need to use
  3913.     the 'pastetoggle' option to toggle the 'paste' option with some key.
  3914.  
  3915.                         *'pastetoggle'* *'pt'*
  3916. 'pastetoggle' 'pt'    string    (default "")
  3917.             global
  3918.             {not in Vi}
  3919.     When non-empty, specifies the key sequence that toggles the 'paste'
  3920.     option.  This is like specifying a mapping: >
  3921.         :map {keys} :set invpaste<CR>
  3922. <    Where {keys} is the value of 'pastetoggle'.
  3923.     The difference is that it will work even when 'paste' is set.
  3924.     'pastetoggle' works in Insert mode and Normal mode, but not in
  3925.     Command-line mode.
  3926.     Mappings are checked first, thus overrule 'pastetoggle'.  However,
  3927.     when 'paste' is on mappings are ignored in Insert mode, thus you can do
  3928.     this: >
  3929.         :map <F10> :set paste<CR>
  3930.         :map <F11> :set nopaste<CR>
  3931.         :imap <F10> <C-O>:set paste<CR>
  3932.         :imap <F11> <nop>
  3933.         :set pastetoggle=<F11>
  3934. <    This will make <F10> start paste mode and <F11> stop paste mode.
  3935.     Note that typing <F10> in paste mode inserts "<F10>", since in paste
  3936.     mode everything is inserted literally, except the 'pastetoggle' key
  3937.     sequence.
  3938.  
  3939.                         *'pex'* *'patchexpr'*
  3940. 'patchexpr' 'pex'    string    (default "")
  3941.             global
  3942.             {not in Vi}
  3943.             {not available when compiled without the |+diff|
  3944.             feature}
  3945.     Expression which is evaluated to apply a patch to a file and generate
  3946.     the resulting new version of the file.  See |diff-patchexpr|.
  3947.  
  3948.                         *'patchmode'* *'pm'* *E206*
  3949. 'patchmode' 'pm'    string    (default "")
  3950.             global
  3951.             {not in Vi}
  3952.     When non-empty the oldest version of a file is kept.  This can be used
  3953.     to keep the original version of a file if you are changing files in a
  3954.     source distribution.  Only the first time that a file is written a
  3955.     copy of the original file will be kept.  The name of the copy is the
  3956.     name of the original file with the string in the 'patchmode' option
  3957.     appended.  This option should start with a dot.  Use a string like
  3958.     ".org".  'backupdir' must not be empty for this to work (Detail: The
  3959.     backup file is renamed to the patchmode file after the new file has
  3960.     been successfully written, that's why it must be possible to write a
  3961.     backup file).  If there was no file to be backed up, an empty file is
  3962.     created.
  3963.     When the 'backupskip' pattern matches, a patchmode file is not made.
  3964.     Using 'patchmode' for compressed files appends the extension at the
  3965.     end (e.g., "file.gz.orig"), thus the resulting name isn't always
  3966.     recognized as a compressed file.
  3967.  
  3968.                     *'path'* *'pa'* *E343* *E345* *E347*
  3969. 'path' 'pa'        string    (default on Unix: ".,/usr/include,,"
  3970.                    on OS/2:       ".,/emx/include,,"
  3971.                    other systems: ".,,")
  3972.             global or local to buffer |global-local|
  3973.             {not in Vi}
  3974.     This is a list of directories which will be searched when using the
  3975.     |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
  3976.     being searched for has a relative path (not starting with '/').  The
  3977.     directories in the 'path' option may be relative or absolute.
  3978.     - Use commas to separate directory names: >
  3979.         :set path=.,/usr/local/include,/usr/include
  3980. <    - Spaces can also be used to separate directory names (for backwards
  3981.       compatibility with version 3.0).  To have a space in a directory
  3982.       name, precede it with an extra backslash, and escape the space: >
  3983.         :set path=.,/dir/with\\\ space
  3984. <    - To include a comma in a directory name precede it with an extra
  3985.       backslash: >
  3986.         :set path=.,/dir/with\\,comma
  3987. <    - To search relative to the directory of the current file, use: >
  3988.         :set path=.
  3989. <    - To search in the current directory use an empty string between two
  3990.       commas: >
  3991.         :set path=,,
  3992. <    - A directory name may end in a ':' or '/'.
  3993.     - Environment variables are expanded |:set_env|.
  3994.     - When using |netrw.vim| URLs can be used.  For example, adding
  3995.       "http://www.vim.org" will make ":find index.html" work.
  3996.     - Search upwards and downwards in a directory tree:
  3997.       1) "*" matches a sequence of characters, e.g.: >
  3998.         :set path=/usr/include/*
  3999. <         means all subdirectories in /usr/include (but not /usr/include
  4000.          itself). >
  4001.         :set path=/usr/*c
  4002. <         matches /usr/doc and /usr/src.
  4003.       2) "**" matches a subtree, up to 100 directories deep.  Example: >
  4004.         :set path=/home/user_x/src/**
  4005. <         means search in the whole subtree under "/home/usr_x/src".
  4006.       3) If the path ends with a ';', this path is the startpoint
  4007.          for upward search.
  4008.       See |file-searching| for more info and exact syntax.
  4009.       {not available when compiled without the |+path_extra| feature}
  4010.     - Careful with '\' characters, type two to get one in the option: >
  4011.         :set path=.,c:\\include
  4012. <      Or just use '/' instead: >
  4013.         :set path=.,c:/include
  4014. <    Don't forget "." or files won't even be found in the same directory as
  4015.     the file!
  4016.     The maximum length is limited.  How much depends on the system, mostly
  4017.     it is something like 256 or 1024 characters.
  4018.     You can check if all the include files are found, using the value of
  4019.     'path', see |:checkpath|.
  4020.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  4021.     directories from the list.  This avoids problems when a future version
  4022.     uses another default.  To remove the current directory use: >
  4023.         :set path-=
  4024. <    To add the current directory use: >
  4025.         :set path+=
  4026. <    To use an environment variable, you probably need to replace the
  4027.     separator.  Here is an example to append $INCL, in which directory
  4028.     names are separated with a semi-colon: >
  4029.         :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
  4030. <    Replace the ';' with a ':' or whatever separator is used.  Note that
  4031.     this doesn't work when $INCL contains a comma or white space.
  4032.  
  4033.                     *'previewheight'* *'pvh'*
  4034. 'previewheight' 'pvh'    number (default 12)
  4035.             global
  4036.             {not in Vi}
  4037.             {not available when compiled without the |+windows| or
  4038.             |+quickfix| feature}
  4039.     Default height for a preview window.  Used for |:ptag| and associated
  4040.     commands.  Used for |CTRL-W_}| when no count is given.
  4041.  
  4042.             *'previewwindow'* *'nopreviewwindow'* *'pvw'* *'nopvw'*
  4043. 'previewwindow' 'pvw'    boolean (default off)
  4044.             local to window
  4045.             {not in Vi}
  4046.             {not available when compiled without the |+windows| or
  4047.             |+quickfix| feature}
  4048.     Identifies the preview window.  Only one window can have this option
  4049.     set.  It's normally not set directly, but by using one of the commands
  4050.     |:ptag|, |:pedit|, etc.
  4051.  
  4052.                         *'printdevice'* *'pdev'*
  4053. 'printdevice' 'pdev'    string    (default empty)
  4054.             global
  4055.             {not in Vi}
  4056.             {only available when compiled with the |+printer|
  4057.             feature}
  4058.     This defines the name of the printer to be used when the |:hardcopy|
  4059.     command is issued with a bang (!) to skip the printer selection
  4060.     dialog.  On Win32, it should be the printer name exactly as it appears
  4061.     in the standard printer dialog.
  4062.     If the option is empty, then vim will use the system default printer
  4063.     for ":hardcopy!"
  4064.  
  4065.                         *'printexpr'* *'pexpr'*
  4066. 'printexpr' 'pexpr'    String    (default: see below)
  4067.             global
  4068.             {not in Vi}
  4069.             {only available when compiled with the |+printer|
  4070.             and |+postscript| features}
  4071.     Expression that is evaluated to print the PostScript produced with
  4072.     ":hardcopy".
  4073.     The file name to be printed is in |v:fname_in|.
  4074.     The arguments to the ":hardcopy" command are in |v:cmdarg|.
  4075.     The expression must take care of deleting the file after printing it.
  4076.     When there is an error, the expression must return a non-zero number.
  4077.     If there is no error, return zero or an empty string.
  4078.     The default for non MS-Windows or VMS systems is to simply use "lpr"
  4079.     to print the file: >
  4080.  
  4081.         system('lpr' . (&printdevice == '' ? '' : ' -P' . &printdevice)
  4082.         . ' ' . v:fname_in) . delete(v:fname_in) + v:shell_error
  4083. <
  4084.     On MS-Windows machines the default is to copy the file to the
  4085.     currently specified printdevice: >
  4086.  
  4087.         system('copy' . ' ' . v:fname_in . ' ' &printdevice)
  4088.             . delete(v:fname_in)
  4089. <
  4090.     On VMS machines the default is to send the file to either the default
  4091.     or currently specified printdevice: >
  4092.  
  4093.         system('print' . (&printdevice == '' ? '' : ' /queue=' . 
  4094.                         &printdevice) . ' ' . v:fname_in) . delete(v:fname_in)
  4095. <
  4096.     If you change this option, using a function is an easy way to avoid
  4097.     having to escape all the spaces.  Example: >
  4098.  
  4099.         :set printexpr=PrintFile(v:fname_in)
  4100.         :function PrintFile(fname)
  4101.         :  call system("ghostview " . a:fname)
  4102.         :  call delete(a:fname)
  4103.         :  return v:shell_error
  4104.         :endfunc
  4105.  
  4106. <    Be aware that some print programs return control before they have read
  4107.     the file.  If you delete the file too soon it will not be printed.
  4108.     These programs usually offer an option to have them remove the file
  4109.     when printing is done.
  4110.                                 *E365*
  4111.     If evaluating the expression fails or it results in a non-zero number,
  4112.     you get an error message.  In that case Vim will delete the
  4113.     file.  In the default value for non-MS-Windows a trick is used: Adding
  4114.     "v:shell_error" will result in a non-zero number when the system()
  4115.     call fails.
  4116.     This option cannot be set from a |modeline|, for security reasons.
  4117.  
  4118.                         *'printfont'* *'pfn'*
  4119. 'printfont' 'pfn'    string    (default "courier")
  4120.             global
  4121.             {not in Vi}
  4122.             {only available when compiled with the |+printer|
  4123.             feature}
  4124.     This is the name of the font that will be used for the |:hardcopy|
  4125.     command's output.  It has the same format as the 'guifont' option,
  4126.     except that only one font may be named, and the special "guifont=*"
  4127.     syntax is not available.
  4128.     In the Win32 GUI version this specifies a font name with its extra
  4129.     attributes, as with the 'guifont' option.
  4130.     For other systems, only ":h11" is recognized, where "11" is the point
  4131.     size of the font.  When omitted, the points size is 10.
  4132.  
  4133.                         *'printheader'* *'pheader'*
  4134. 'printheader' 'pheader'  string  (default "%<%f%h%m%=Page %N")
  4135.             global
  4136.             {not in Vi}
  4137.             {only available when compiled with the |+printer|
  4138.             feature}
  4139.     This defines the format of the header produced in |:hardcopy| output.
  4140.     The option is defined in the same way as the 'statusline' option.
  4141.     If Vim has not been compiled with the |+statusline| feature, this
  4142.     option has no effect and a simple default header is used, which shows
  4143.     the page number.
  4144.  
  4145.                         *'printoptions'* *'popt'*
  4146. 'printoptions' 'popt' string (default "")
  4147.             global
  4148.             {not in Vi}
  4149.             {only available when compiled with |+printer| feature}
  4150.     This is a comma-separated list of items that control the format of
  4151.     the output of |:hardcopy|:
  4152.  
  4153.       left:{spec}        left margin (default: 10pc)
  4154.       right:{spec}        right margin (default: 5pc)
  4155.       top:{spec}        top margin (default: 5pc)
  4156.       bottom:{spec}        bottom margin (default: 5pc)
  4157.                 {spec} is a number followed by "in" for
  4158.                 inches, "pt" for points (1 point is 1/72 of an
  4159.                 inch), "mm" for millimetres or "pc" for a
  4160.                 percentage of the media size.
  4161.                 Weird example:
  4162.                     left:2in,top:30pt,right:16mm,bottom:3pc
  4163.                 If the unit is not recognized there is no
  4164.                 error and the default value is used.
  4165.  
  4166.       header:{nr}        Number of lines to reserve for the header.
  4167.                 Only the first line is actually filled, thus
  4168.                 when {nr} is 2 there is one empty line.  The
  4169.                 header is formatted according to
  4170.                 'printheader'.
  4171.       header:0        Do not print a header.
  4172.       header:2  (default)    Use two lines for the header
  4173.  
  4174.       syntax:n        Do not use syntax highlighting.  This is
  4175.                 faster and thus useful when printing large
  4176.                 files.
  4177.       syntax:y        Do syntax highlighting.
  4178.       syntax:a  (default)    Use syntax highlighting if the printer appears
  4179.                 to be able to print color or grey.
  4180.  
  4181.       number:y        Include line numbers in the printed output.
  4182.       number:n  (default)    No line numbers.
  4183.  
  4184.       wrap:y    (default)   Wrap long lines.
  4185.       wrap:n        Truncate long lines.
  4186.  
  4187.       duplex:off        Print on one side.
  4188.       duplex:long (default)    Print on both sides (when possible), bind on
  4189.                 long side.
  4190.       duplex:short        Print on both sides (when possible), bind on
  4191.                 short side.
  4192.  
  4193.       collate:y  (default)    Collating: 1 2 3, 1 2 3, 1 2 3
  4194.       collate:n        No collating: 1 1 1, 2 2 2, 3 3 3
  4195.  
  4196.       jobsplit:n (default)    Do all copies in one print job
  4197.       jobsplit:y        Do each copy as a separate print job.  Useful
  4198.                 when doing N-up postprocessing.
  4199.  
  4200.       portrait:y (default)    Orientation is portrait.
  4201.       portrait:n        Orientation is landscape.
  4202.  
  4203.  
  4204.       paper:A4   (default)    Paper size: A4
  4205.       paper:{name}        Paper size from this table:
  4206.                     {name}         size in inch ~
  4207.                     10x14        10    x 14
  4208.                     A3        11.69 x 16.54
  4209.                     A4         8.27 x 11.69
  4210.                     A5         5.83 x    8.27
  4211.                     B4        10.12 x 14.33
  4212.                     B5         7.17 x 10.12
  4213.                     executive     7.25 x 10.5
  4214.                     folio         8.27 x 13
  4215.                     ledger        17    x 11
  4216.                     legal         8.5  x 14
  4217.                     letter         8.5  x 11
  4218.                     quarto         8.5  x 10.83
  4219.                     statement     5.5  x    8.5
  4220.                     tabloid        11    x 17
  4221.  
  4222.     The item indicated with (default) is used when the item is not
  4223.     present.  The values are not always used, especially when using a
  4224.     dialog to select the printer and options.
  4225.     Example: >
  4226.         :set printoptions=paper:letter,duplex:off
  4227. <
  4228.                    *'readonly'* *'ro'* *'noreadonly'* *'noro'*
  4229. 'readonly' 'ro'        boolean    (default off)
  4230.             local to buffer
  4231.             {not in Vi}
  4232.     If on, writes fail unless you use a '!'.  Protects you from
  4233.     accidentally overwriting a file.  Default on when Vim is started
  4234.     in read-only mode ("vim -R") or when the executable is called "view".
  4235.     {not in Vi:}  When using the ":view" command the 'readonly' option is
  4236.     set for the newly edited buffer.  When using ":w!" the 'readonly'
  4237.     option is reset for the current buffer.
  4238.  
  4239.                         *'remap'* *'noremap'*
  4240. 'remap'            boolean    (default on)
  4241.             global
  4242.     Allows for mappings to work recursively.  If you do not want this for
  4243.     a single entry, use the :noremap[!] command.
  4244.  
  4245.                         *'report'*
  4246. 'report'        number    (default 2)
  4247.             global
  4248.     Threshold for reporting number of lines changed.  When the number of
  4249.     changed lines is more than 'report' a message will be given for most
  4250.     ":" commands.  If you want it always, set 'report' to 0.
  4251.     For the ":substitute" command the number of substitutions is used
  4252.     instead of the number of lines.
  4253.  
  4254.              *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
  4255. 'restorescreen' 'rs'    boolean    (default on)
  4256.             global
  4257.             {not in Vi}  {Windows 95/NT console version only}
  4258.     When set, the screen contents is restored when exiting Vim.  This also
  4259.     happens when executing external commands.
  4260.  
  4261.     For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
  4262.     options in your .vimrc.  To disable restoring:
  4263.         set t_ti= t_te=
  4264.     To enable restoring (for an xterm):
  4265.         set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
  4266.     (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
  4267.  
  4268.                 *'revins'* *'ri'* *'norevins'* *'nori'*
  4269. 'revins' 'ri'        boolean    (default off)
  4270.             global
  4271.             {not in Vi}
  4272.             {only available when compiled with the |+rightleft|
  4273.             feature}
  4274.     Inserting characters in Insert mode will work backwards.  See "typing
  4275.     backwards" |ins-reverse|.  This option can be toggled with the CTRL-_
  4276.     command in Insert mode, when 'allowrevins' is set.
  4277.     NOTE: This option is reset when 'compatible' or 'paste' is set.
  4278.  
  4279.                  *'rightleft'* *'rl'* *'norightleft'* *'norl'*
  4280. 'rightleft' 'rl'    boolean    (default off)
  4281.             local to window
  4282.             {not in Vi}
  4283.             {only available when compiled with the |+rightleft|
  4284.             feature}
  4285.     When on, display orientation becomes right-to-left, i.e., character
  4286.     that are stored in the file appear from the right to the left.  Using
  4287.     this option, it is possible to edit files for languages that are
  4288.     written from the right to the left such as Hebrew and Arabic.  This
  4289.     option is per window, so it is possible to edit mixed files
  4290.     simultaneously, or to view the same file in both ways (this is
  4291.     sometimes useful when editing Hebrew TeX--XeT files).  See
  4292.     |rileft.txt|.
  4293.  
  4294.                      *'ruler'* *'ru'* *'noruler'* *'noru'*
  4295. 'ruler' 'ru'        boolean    (default off)
  4296.             global
  4297.             {not in Vi}
  4298.             {not available when compiled without the
  4299.             |+cmdline_info| feature}
  4300.     Show the line and column number of the cursor position, separated by a
  4301.     comma.  When there is room, the relative position of the displayed
  4302.     text in the file is shown on the far right:
  4303.         Top    first line is visible
  4304.         Bot    last line is visible
  4305.         All    first and last line are visible
  4306.         45%    relative position in the file
  4307.     If 'rulerformat' is set, it will determine the contents of the ruler.
  4308.     Each window has its own ruler.  If a window has a status line, the
  4309.     ruler is shown there.  Otherwise it is shown in the last line of the
  4310.     screen.  If the statusline is given by 'statusline' (ie. not empty),
  4311.     this option takes precedence over 'ruler' and 'rulerformat'
  4312.     If the number of characters displayed is different from the number of
  4313.     bytes in the text (e.g., for a TAB or a multi-byte character), both
  4314.     the text column (byte number) and the screen column are shown,
  4315.     separated with a dash.
  4316.     For an empty line "0-1" is shown.
  4317.     For an empty buffer the line number will also be zero: "0,0-1".
  4318.     This option is reset when the 'paste' option is set.
  4319.     If you don't want to see the ruler all the time but want to know where
  4320.     you are, use "g CTRL-G" |g_CTRL-G|.
  4321.     NOTE: This option is reset when 'compatible' is set.
  4322.  
  4323.                         *'rulerformat'* *'ruf'*
  4324. 'rulerformat' 'ruf'    string    (default empty)
  4325.             global
  4326.             {not in Vi}
  4327.             {not available when compiled without the |+statusline|
  4328.             feature}
  4329.     When this option is not empty, it determines the content of the ruler
  4330.     string, as displayed for the 'ruler' option.
  4331.     The format of this option, is like that of 'statusline'.
  4332.     The default ruler width is 17 characters.  To make the ruler 15
  4333.     characters wide, put "%15(" at the start and "%)" at the end.
  4334.     Example: >
  4335.         :set rulerformat=%15(%c%V\ %p%%%)
  4336. <
  4337.                         *'runtimepath'* *'rtp'*
  4338. 'runtimepath' 'rtp'    string    (default:
  4339.                     Unix: "$HOME/.vim,
  4340.                         $VIM/vimfiles,
  4341.                         $VIMRUNTIME,
  4342.                         $VIM/vimfiles/after,
  4343.                         $HOME/.vim/after"
  4344.                     Amiga: "home:vimfiles,
  4345.                         $VIM/vimfiles,
  4346.                         $VIMRUNTIME,
  4347.                         $VIM/vimfiles/after,
  4348.                         home:vimfiles/after"
  4349.                     PC, OS/2: "$HOME/vimfiles,
  4350.                         $VIM/vimfiles,
  4351.                         $VIMRUNTIME,
  4352.                         $VIM/vimfiles/after,
  4353.                         $HOME/vimfiles/after"
  4354.                     Macintosh: "$VIM:vimfiles,
  4355.                         $VIMRUNTIME,
  4356.                         $VIM:vimfiles:after"
  4357.                     RISC-OS: "Choices:vimfiles,
  4358.                         $VIMRUNTIME,
  4359.                         Choices:vimfiles/after"
  4360.                     VMS: "sys$login:vimfiles,
  4361.                         $VIM/vimfiles,
  4362.                         $VIMRUNTIME,
  4363.                         $VIM/vimfiles/after,
  4364.                         sys$login:vimfiles/after"
  4365.             global
  4366.             {not in Vi}
  4367.     This is a list of directories which will be searched for runtime
  4368.     files:
  4369.       filetype.vim    filetypes by file name |new-filetype|
  4370.       scripts.vim    filetypes by file contents |new-filetype-scripts|
  4371.       colors/    color scheme files |:colorscheme|
  4372.       compiler/    compiler files |:compiler|
  4373.       doc/        documentation |write-local-help|
  4374.       ftplugin/    filetype plugins |write-filetype-plugin|
  4375.       indent/    indent scripts |indent-expression|
  4376.       keymap/    key mapping files |mbyte-keymap|
  4377.       lang/        menu translations |:menutrans|
  4378.       menu.vim    GUI menus |menu.vim|
  4379.       plugin/    plugin scripts |write-plugin|
  4380.       syntax/    syntax files |mysyntaxfile|
  4381.       tutor/    files for vimtutor |tutor|
  4382.  
  4383.     And any other file searched for with the |:runtime| command.
  4384.  
  4385.     The defaults for most systems are setup to search five locations:
  4386.     1. In your home directory, for your personal preferences.
  4387.     2. In a system-wide Vim directory, for preferences from the system
  4388.        administrator.
  4389.     3. In $VIMRUNTIME, for files distributed with Vim.
  4390.     4. In the "after" directory in the system-wide Vim directory.  This is
  4391.        for the system administrator to overrule or add to the distributed
  4392.        defaults (rarely needed)
  4393.     5. In the "after" directory in your home directory.  This is for
  4394.        personal preferences to overrule or add to the distributed defaults
  4395.        or system-wide settings (rarely needed).
  4396.  
  4397.     Note that, unlike 'path', no wildcards like "**" are allowed.  Normal
  4398.     wildcards are allowed, but can significantly slow down searching for
  4399.     runtime files.  For speed, use as few items as possible and avoid
  4400.     wildcards.
  4401.     See |:runtime|.
  4402.     Example: >
  4403.         :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
  4404. <    This will use the directory "~/vimruntime" first (containing your
  4405.     personal Vim runtime files), then "/mygroup/vim" (shared between a
  4406.     group of people) and finally "$VIMRUNTIME" (the distributed runtime
  4407.     files).
  4408.     You probably should always include $VIMRUNTIME somewhere, to use the
  4409.     distributed runtime files.  You can put a directory before $VIMRUNTIME
  4410.     to find files which replace a distributed runtime files.  You can put
  4411.     a directory after $VIMRUNTIME to find files which add to distributed
  4412.     runtime files.
  4413.     This option cannot be set from a |modeline|, for security reasons.
  4414.  
  4415.                         *'scroll'* *'scr'*
  4416. 'scroll' 'scr'        number    (default 'lines' / 2)
  4417.             local to window
  4418.     Number of lines to scroll with CTRL-U and CTRL-D commands.  Will be
  4419.     set to half the number of lines in the window when the window size
  4420.     changes.  If you give a count to the CTRL-U or CTRL-D command it will
  4421.     be used as the new value for 'scroll'.  Reset to 'lines' / 2 with
  4422.     ":set scroll=0".   {Vi is a bit different: 'scroll' gives the number
  4423.     of screen lines instead of file lines, makes a difference when lines
  4424.     wrap}
  4425.  
  4426.             *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
  4427. 'scrollbind' 'scb'    boolean  (default off)
  4428.             local to window
  4429.             {not in Vi}
  4430.             {not available when compiled without the |+scrollbind|
  4431.             feature}
  4432.     See also |scroll-binding|.  When this option is set, the current
  4433.     window scrolls as other scrollbind windows (windows that also have
  4434.     this option set) scroll.  This option is useful for viewing the
  4435.     differences between two versions of a file, see 'diff'.
  4436.     See |'scrollopt'| for options that determine how this option should be
  4437.     interpreted.
  4438.  
  4439.                         *'scrolljump'* *'sj'*
  4440. 'scrolljump' 'sj'    number    (default 1)
  4441.             global
  4442.             {not in Vi}
  4443.     Minimal number of lines to scroll when the cursor gets off the
  4444.     screen (e.g., with "j").  Not used for scroll commands (e.g., CTRL-E,
  4445.     CTRL-D).  Useful if your terminal scrolls very slowly.
  4446.     NOTE: This option is set to 1 when 'compatible' is set.
  4447.  
  4448.                         *'scrolloff'* *'so'*
  4449. 'scrolloff' 'so'    number    (default 0)
  4450.             global
  4451.             {not in Vi}
  4452.     Minimal number of screen lines to keep above and below the cursor.
  4453.     This will make some context visible around where you are working.  If
  4454.     you set it to a very large value (999) the cursor line will always be
  4455.     in the middle of the window (except at the start or end of the file or
  4456.     when long lines wrap).
  4457.     For scrolling horizontallly see 'sidescrolloff'.
  4458.     NOTE: This option is set to 0 when 'compatible' is set.
  4459.  
  4460.                         *'scrollopt'* *'sbo'*
  4461. 'scrollopt' 'sbo'    string    (default "ver,jump")
  4462.             global
  4463.             {not available when compiled without the |+scrollbind|
  4464.             feature}
  4465.             {not in Vi}
  4466.     This is a comma-separated list of words that specifies how
  4467.     'scrollbind' windows should behave.
  4468.     The following words are available:
  4469.         ver        Bind vertical scrolling for 'scrollbind' windows
  4470.         hor        Bind horizontal scrolling for 'scrollbind' windows
  4471.         jump    Applies to the offset between two windows for vertical
  4472.             scrolling.  This offset is the difference in the first
  4473.             displayed line of the bound windows.  When moving
  4474.             around in a window, another 'scrollbind' window may
  4475.             reach a position before the start or after the end of
  4476.             the buffer.  The offset is not changed though, when
  4477.             moving back the 'scrollbind' window will try to scroll
  4478.             to the desired position when possible.
  4479.             When now making that window the current one, two
  4480.             things can be done with the relative offset:
  4481.             1. When "jump" is not included, the relative offset is
  4482.                adjusted for the scroll position in the new current
  4483.                window.  When going back to the other window, the
  4484.                the new relative offset will be used.
  4485.             2. When "jump" is included, the other windows are
  4486.                scrolled to keep the same relative offset.  When
  4487.                going back to the other window, it still uses the
  4488.                same relative offset.
  4489.     Also see |scroll-binding|.
  4490.  
  4491.                         *'sections'* *'sect'*
  4492. 'sections' 'sect'    string    (default "SHNHH HUnhsh")
  4493.             global
  4494.     Specifies the nroff macros that separate sections.  These are pairs of
  4495.     two letters (See |object-motions|).  The default makes a section start
  4496.     at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
  4497.  
  4498.                         *'secure'* *'nosecure'*
  4499. 'secure'        boolean    (default off)
  4500.             global
  4501.             {not in Vi}
  4502.     When on, ":autocmd", shell and write commands are not allowed in
  4503.     ".vimrc" and ".exrc" in the current directory and map commands are
  4504.     displayed.  Switch it off only if you know that you will not run into
  4505.     problems, or when the 'exrc' option is off.  On Unix this option is
  4506.     only used if the ".vimrc" or ".exrc" is not owned by you.  This can be
  4507.     dangerous if the systems allows users to do a "chown".  You better set
  4508.     'secure' at the end of your ~/.vimrc then.
  4509.     This option cannot be set from a |modeline|, for security reasons.
  4510.  
  4511.                         *'selection'* *'sel'*
  4512. 'selection' 'sel'    string    (default "inclusive")
  4513.             global
  4514.             {not in Vi}
  4515.     This option defines the behavior of the selection.  It is only used
  4516.     in Visual and Select mode.
  4517.     Possible values:
  4518.        value    past line     inclusive ~
  4519.        old           no        yes
  4520.        inclusive       yes        yes
  4521.        exclusive       yes        no
  4522.     "past line" means that the cursor is allowed to be positioned one
  4523.     character past the line.
  4524.     "inclusive" means that the last character of the selection is included
  4525.     in an operation.  For example, when "x" is used to delete the
  4526.     selection.
  4527.  
  4528.     The 'selection' option is set by the |:behave| command.
  4529.  
  4530.                         *'selectmode'* *'slm'*
  4531. 'selectmode' 'slm'    string    (default "")
  4532.             global
  4533.             {not in Vi}
  4534.     This is a comma separated list of words, which specifies when to start
  4535.     Select mode instead of Visual mode, when a selection is started.
  4536.     Possible values:
  4537.        mouse    when using the mouse
  4538.        key        when using shifted special keys
  4539.        cmd        when using "v", "V" or CTRL-V
  4540.     See |Select-mode|.
  4541.     The 'selectmode' option is set by the |:behave| command.
  4542.  
  4543.                         *'sessionoptions'* *'ssop'*
  4544. 'sessionoptions' 'ssop'    string    (default: "blank,buffers,curdir,folds,
  4545.                             help,options,winsize")
  4546.             global
  4547.             {not in Vi}
  4548.             {not available when compiled without the +mksession
  4549.             feature}
  4550.     Changes the effect of the |:mksession| command.  It is a comma
  4551.     separated list of words.  Each word enables saving and restoring
  4552.     something:
  4553.        word        save and restore ~
  4554.        blank    empty windows
  4555.        buffers    hidden and unloaded buffers, not just those in windows
  4556.        curdir    the current directory
  4557.        folds    manually created folds, opened/closed folds and local
  4558.             fold options
  4559.        globals    global variables that start with an uppercase letter
  4560.             and contain at least one lowercase letter.
  4561.        help        the help window
  4562.        localoptions    options and mappings local to a window or buffer (not
  4563.             global values for local options)
  4564.        options    all options and mappings (also global values for local
  4565.             options)
  4566.        resize    size of the Vim window: 'lines' and 'columns'
  4567.        sesdir    the directory in which the session file is located
  4568.             will become the current directory (useful with
  4569.             projects accessed over a network from different
  4570.             systems)
  4571.        slash    backslashes in file names replaced with forward
  4572.             slashes
  4573.        unix        with Unix end-of-line format (single <NL>), even when
  4574.             on Windows or DOS
  4575.        winpos    position of the whole Vim window
  4576.        winsize    window sizes
  4577.  
  4578.     Don't include both "curdir" and "sesdir".
  4579.     When "curdir" nor "sesdir" is included, file names are stored with
  4580.     absolute paths.
  4581.     "slash" and "unix" are useful on Windows when sharing session files
  4582.     with Unix.  The Unix version of Vim cannot source dos format scripts,
  4583.     but the Windows version of Vim can source unix format scripts.
  4584.  
  4585.                         *'shell'* *'sh'* *E91*
  4586. 'shell' 'sh'        string    (default $SHELL or "sh",
  4587.                     MS-DOS and Win32: "command.com" or
  4588.                     "cmd.exe", OS/2: "cmd")
  4589.             global
  4590.     Name of the shell to use for ! and :! commands.  When changing the
  4591.     value also check these options: 'shelltype', 'shellpipe', 'shellslash'
  4592.     'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
  4593.     It is allowed to give an argument to the command, e.g.  "csh -f".
  4594.     See |option-backslash| about including spaces and backslashes.
  4595.     Environment variables are expanded |:set_env|.
  4596.     If the name of the shell contains a space, you might need to enclose
  4597.     it in quotes.  Example: >
  4598.         :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
  4599. <    Note the backslash before each quote (to avoid starting a comment) and
  4600.     each space (to avoid ending the option value).  Also note that the
  4601.     "-f" is not inside the quotes, because it is not part of the command
  4602.     name.  And Vim automagically recognizes the backslashes that are path
  4603.     separators.
  4604.     For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
  4605.     variable to change the way external commands are executed.  See the
  4606.     libc.inf file of DJGPP.
  4607.     Under MS-Windows, when the executable ends in ".com" it must be
  4608.     included.  Thus setting the shell to "command.com" or "4dos.com"
  4609.     works, but "command" and "4dos" do not work for all commands (e.g.,
  4610.     filtering).
  4611.     For unknown reasons, when using "4dos.com" the current directory is
  4612.     changed to "C:\".  To avoid this set 'shell' like this: >
  4613.         :set shell=command.com\ /c\ 4dos
  4614. <    This option cannot be set from a |modeline|, for security reasons.
  4615.  
  4616.                         *'shellcmdflag'* *'shcf'*
  4617. 'shellcmdflag' 'shcf'    string    (default: "-c", MS-DOS and Win32, when 'shell'
  4618.                     does not contain "sh" somewhere: "/c")
  4619.             global
  4620.             {not in Vi}
  4621.     Flag passed to the shell to execute "!" and ":!" commands; e.g.,
  4622.     "bash.exe -c ls" or "command.com /c dir".  For the MS-DOS-like
  4623.     systems, the default is set according to the value of 'shell', to
  4624.     reduce the need to set this option by the user.  It's not used for
  4625.     OS/2 (EMX figures this out itself).  See |option-backslash| about
  4626.     including spaces and backslashes.  See |dos-shell|.
  4627.     This option cannot be set from a |modeline|, for security reasons.
  4628.  
  4629.                         *'shellpipe'* *'sp'*
  4630. 'shellpipe' 'sp'    string    (default ">", "| tee", "|& tee" or "2>&1| tee")
  4631.             global
  4632.             {not in Vi}
  4633.             {not available when compiled without the |+quickfix|
  4634.             feature}
  4635.     String to be used to put the output of the ":make" command in the
  4636.     error file.  See also |:make_makeprg|.  See |option-backslash| about
  4637.     including spaces and backslashes.
  4638.     The name of the temporary file can be represented by "%s" if necessary
  4639.     (the file name is appended automatically if no %s appears in the value
  4640.     of this option).
  4641.     For the Amiga and MS-DOS the default is ">".  The output is directly
  4642.     saved in a file and not echoed to the screen.
  4643.     For Unix the default it "| tee".  The stdout of the compiler is saved
  4644.     in a file and echoed to the screen.  If the 'shell' option is "csh" or
  4645.     "tcsh" after initializations, the default becomes "|& tee".  If the
  4646.     'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
  4647.     "2>&1| tee".  This means that stderr is also included.
  4648.     The initialization of this option is done after reading the ".vimrc"
  4649.     and the other initializations, so that when the 'shell' option is set
  4650.     there, the 'shellpipe' option changes automatically, unless it was
  4651.     explicitly set before.
  4652.     When 'shellpipe' is set to an empty string, no redirection of the
  4653.     ":make" output will be done.  This is useful if you use a 'makeprg'
  4654.     that writes to 'makeef' by itself.  If you want no piping, but do
  4655.     want to include the 'makeef', set 'shellpipe' to a single space.
  4656.     Don't forget to precede the space with a backslash: ":set sp=\ ".
  4657.     In the future pipes may be used for filtering and this option will
  4658.     become obsolete (at least for Unix).
  4659.     This option cannot be set from a |modeline|, for security reasons.
  4660.  
  4661.                         *'shellquote'* *'shq'*
  4662. 'shellquote' 'shq'    string    (default: ""; MS-DOS and Win32, when 'shell'
  4663.                     contains "sh" somewhere: "\"")
  4664.             global
  4665.             {not in Vi}
  4666.     Quoting character(s), put around the command passed to the shell, for
  4667.     the "!" and ":!" commands.  The redirection is kept outside of the
  4668.     quoting.  See 'shellxquote' to include the redirection.  It's
  4669.     probably not useful to set both options.
  4670.     This is an empty string by default.  Only known to be useful for
  4671.     third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
  4672.     or bash, where it should be "\"".  The default is adjusted according
  4673.     the value of 'shell', to reduce the need to set this option by the
  4674.     user.  See |dos-shell|.
  4675.     This option cannot be set from a |modeline|, for security reasons.
  4676.  
  4677.                         *'shellredir'* *'srr'*
  4678. 'shellredir' 'srr'    string    (default ">", ">&" or ">%s 2>&1")
  4679.             global
  4680.             {not in Vi}
  4681.     String to be used to put the output of a filter command in a temporary
  4682.     file.  See also |:!|.  See |option-backslash| about including spaces
  4683.     and backslashes.
  4684.     The name of the temporary file can be represented by "%s" if necessary
  4685.     (the file name is appended automatically if no %s appears in the value
  4686.     of this option).
  4687.     The default is ">".  For Unix, if the 'shell' option is "csh", "tcsh"
  4688.     or "zsh" during initializations, the default becomes ">&".  If the
  4689.     'shell' option is "sh", "ksh" or "bash" the default becomes
  4690.     ">%s 2>&1".  This means that stderr is also included.
  4691.     For Win32, the Unix checks are done and additionally "cmd" is checked
  4692.     for, which makes the default ">%s 2>&1".  Also, the same names with
  4693.     ".exe" appended are checked for.
  4694.     The initialization of this option is done after reading the ".vimrc"
  4695.     and the other initializations, so that when the 'shell' option is set
  4696.     there, the 'shellredir' option changes automatically unless it was
  4697.     explicitly set before.
  4698.     In the future pipes may be used for filtering and this option will
  4699.     become obsolete (at least for Unix).
  4700.     This option cannot be set from a |modeline|, for security reasons.
  4701.  
  4702.             *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
  4703. 'shellslash' 'ssl'    boolean    (default off)
  4704.             global
  4705.             {not in Vi} {only for MSDOS, MS-Windows and OS/2}
  4706.     When set, a forward slash is used when expanding file names.  This is
  4707.     useful when a Unix-like shell is used instead of command.com or
  4708.     cmd.exe.  Backward slashes can still be typed, but they are changed to
  4709.     forward slashes by Vim.
  4710.     Note that setting or resetting this option has no effect for some
  4711.     existing file names, thus this option needs to be set before opening
  4712.     any file for best results.  This might change in the future.
  4713.  
  4714.                         *'shelltype'* *'st'*
  4715. 'shelltype' 'st'    number    (default 0)
  4716.             global
  4717.             {not in Vi} {only for the Amiga}
  4718.     On the Amiga this option influences the way how the commands work
  4719.     which use a shell.
  4720.     0 and 1: always use the shell
  4721.     2 and 3: use the shell only to filter lines
  4722.     4 and 5: use shell only for ':sh' command
  4723.     When not using the shell, the command is executed directly.
  4724.  
  4725.     0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
  4726.     1 and 3: use "shell cmd" to start external commands
  4727.  
  4728.                         *'shellxquote'* *'sxq'*
  4729. 'shellxquote' 'sxq'    string    (default: "";
  4730.                     for Win32, when 'shell' contains "sh"
  4731.                     somewhere: "\""
  4732.                     for Unix, when using system(): "\"")
  4733.             global
  4734.             {not in Vi}
  4735.     Quoting character(s), put around the command passed to the shell, for
  4736.     the "!" and ":!" commands.  Includes the redirection.  See
  4737.     'shellquote' to exclude the redirection.  It's probably not useful
  4738.     to set both options.
  4739.     This is an empty string by default.  Known to be useful for
  4740.     third-party shells when using the Win32 version, such as the MKS Korn
  4741.     Shell or bash, where it should be "\"".  The default is adjusted
  4742.     according the value of 'shell', to reduce the need to set this option
  4743.     by the user.  See |dos-shell|.
  4744.     This option cannot be set from a |modeline|, for security reasons.
  4745.  
  4746.             *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
  4747. 'shiftround' 'sr'    boolean    (default off)
  4748.             global
  4749.             {not in Vi}
  4750.     Round indent to multiple of 'shiftwidth'.  Applies to > and <
  4751.     commands.  CTRL-T and CTRL-D in Insert mode always round the indent to
  4752.     a multiple of 'shiftwidth' (this is Vi compatible).
  4753.     NOTE: This option is reset when 'compatible' is set.
  4754.  
  4755.                         *'shiftwidth'* *'sw'*
  4756. 'shiftwidth' 'sw'    number    (default 8)
  4757.             local to buffer
  4758.     Number of spaces to use for each step of (auto)indent.  Used for
  4759.     |'cindent'|, |>>|, |<<|, etc.
  4760.  
  4761.                         *'shortmess'* *'shm'*
  4762. 'shortmess' 'shm'    string    (Vim default "filnxtToO", Vi default: "")
  4763.             global
  4764.             {not in Vi}
  4765.     This option helps to avoid all the |hit-enter| prompts caused by file
  4766.     messages, for example  with CTRL-G, and to avoid some other messages.
  4767.     It is a list of flags:
  4768.      flag    meaning when present    ~
  4769.       f    use "(3 of 5)" instead of "(file 3 of 5)"
  4770.       i    use "[noeol]" instead of "[Incomplete last line]"
  4771.       l    use "999L, 888C" instead of "999 lines, 888 characters"
  4772.       m    use "[+]" instead of "[Modified]"
  4773.       n    use "[New]" instead of "[New File]"
  4774.       r    use "[RO]" instead of "[readonly]"
  4775.       w    use "[w]" instead of "written" for file write message
  4776.         and "[a]" instead of "appended" for ':w >> file' command
  4777.       x    use "[dos]" instead of "[dos format]", "[unix]" instead of
  4778.         "[unix format]" and "[mac]" instead of "[mac format]".
  4779.       a    all of the above abbreviations
  4780.  
  4781.       o    overwrite message for writing a file with subsequent message
  4782.         for reading a file (useful for ":wn" or when 'autowrite' on)
  4783.       O    message for reading a file overwrites any previous message.
  4784.         Also for quickfix message (e.g., ":cn").
  4785.       s    don't give "search hit BOTTOM, continuing at TOP" or "search
  4786.         hit TOP, continuing at BOTTOM" messages
  4787.       t    truncate file message at the start if it is too long to fit
  4788.         on the command-line, "<" will appear in the left most column.
  4789.         Ignored in Ex mode.
  4790.       T    truncate other messages in the middle if they are too long to
  4791.         fit on the command line. "..." will appear in the middle.
  4792.         Ignored in Ex mode.
  4793.       W    don't give "written" or "[w]" when writing a file
  4794.       A    don't give the "ATTENTION" message when an existing swap file
  4795.         is found.
  4796.       I    don't give the intro message when starting Vim |:intro|.
  4797.  
  4798.     This gives you the opportunity to avoid that a change between buffers
  4799.     requires you to hit <Enter>, but still gives as useful a message as
  4800.     possible for the space available.  To get the whole message that you
  4801.     would have got with 'shm' empty, use ":file!"
  4802.     Useful values:
  4803.         shm=    No abbreviation of message.
  4804.         shm=a    Abbreviation, but no loss of information.
  4805.         shm=at    Abbreviation, and truncate message when necessary.
  4806.  
  4807.     NOTE: This option is set to the Vi default value when 'compatible' is
  4808.     set and to the Vim default value when 'compatible' is reset.
  4809.  
  4810.                  *'shortname'* *'sn'* *'noshortname'* *'nosn'*
  4811. 'shortname' 'sn'    boolean    (default off)
  4812.             local to buffer
  4813.             {not in Vi, not in MS-DOS versions}
  4814.     Filenames are assumed to be 8 characters plus one extension of 3
  4815.     characters.  Multiple dots in file names are not allowed.  When this
  4816.     option is on, dots in file names are replaced with underscores when
  4817.     adding an extension (".~" or ".swp").  This option is not available
  4818.     for MS-DOS, because then it would always be on.  This option is useful
  4819.     when editing files on an MS-DOS compatible filesystem, e.g., messydos
  4820.     or crossdos.  When running the Win32 GUI version under Win32s, this
  4821.     option is always on by default.
  4822.  
  4823.                         *'showbreak'* *'sbr'*
  4824. 'showbreak' 'sbr'    string    (default "")
  4825.             global
  4826.             {not in Vi}
  4827.             {not available when compiled without the  |+linebreak|
  4828.             feature}
  4829.     String to put at the start of lines that have been wrapped.  Useful
  4830.     values are "> " or "+++ ".  Only printable characters are allowed,
  4831.     excluding <Tab> and comma (in a future version the comma might be used
  4832.     to separate the part that is shown at the end and at the start of a
  4833.     line).  The characters are highlighted according to the '@' flag in
  4834.     'highlight'.
  4835.     Note that tabs after the showbreak will be displayed differently.
  4836.     If you want the 'showbreak' to appear in between line numbers, add the
  4837.     "n" flag to 'cpoptions'.
  4838.  
  4839.                      *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
  4840. 'showcmd' 'sc'        boolean    (Vim default: on, off for Unix, Vi default:
  4841.                  off)
  4842.             global
  4843.             {not in Vi}
  4844.             {not available when compiled without the
  4845.             |+cmdline_info| feature}
  4846.     Show (partial) command in status line.  Set this option off if your
  4847.     terminal is slow.
  4848.     In Visual mode the size of the selected area is shown:
  4849.     - When selecting characters within a line, the number of characters.
  4850.     - When selecting more than one line, the number of lines.
  4851.     - When selecting a block, the size in screen characters: linesxcolumns.
  4852.     NOTE: This option is set to the Vi default value when 'compatible' is
  4853.     set and to the Vim default value when 'compatible' is reset.
  4854.  
  4855.             *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
  4856. 'showfulltag' 'sft'    boolean (default off)
  4857.             global
  4858.             {not in Vi}
  4859.     When completing a word in insert mode (see |ins-completion|) from the
  4860.     tags file, show both the tag name and a tidied-up form of the search
  4861.     pattern (if there is one) as possible matches.  Thus, if you have
  4862.     matched a C function, you can see a template for what arguments are
  4863.     required (coding style permitting).
  4864.  
  4865.                  *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
  4866. 'showmatch' 'sm'    boolean    (default off)
  4867.             global
  4868.     When a bracket is inserted, briefly jump to the matching one.  The
  4869.     jump is only done if the match can be seen on the screen.  The time to
  4870.     show the match can be set with 'matchtime'.
  4871.     A Beep is given if there is no match (no matter if the match can be
  4872.     seen or not).  This option is reset when the 'paste' option is set.
  4873.     When the 'm' flag is not included in 'cpoptions', typing a character
  4874.     will immediately move the cursor back to where it belongs.
  4875.     See the "sm" field in 'guicursor' for setting the cursor shape and
  4876.     blinking when showing the match.
  4877.     Note: For the use of the short form parental guidance is advised.
  4878.  
  4879.                  *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
  4880. 'showmode' 'smd'    boolean    (Vim default: on, Vi default: off)
  4881.             global
  4882.     If in Insert, Replace or Visual mode put a message on the last line.
  4883.     Use the 'M' flag in 'highlight' to set the type of highlighting for
  4884.     this message.
  4885.     When |XIM| may be used the message will include "XIM".  But this
  4886.     doesn't mean XIM is really active, especially when 'imactivatekey' is
  4887.     not set.
  4888.     NOTE: This option is set to the Vi default value when 'compatible' is
  4889.     set and to the Vim default value when 'compatible' is reset.
  4890.  
  4891.                         *'sidescroll'* *'ss'*
  4892. 'sidescroll' 'ss'    number    (default 0)
  4893.             global
  4894.             {not in Vi}
  4895.     The minimal number of columns to scroll horizontally.  Used only when
  4896.     the 'wrap' option is off and the cursor is moved off of the screen.
  4897.     When it is zero the cursor will be put in the middle of the screen.
  4898.     When using a slow terminal set it to a large number or 0.  When using
  4899.     a fast terminal use a small number or 1.  Not used for "zh" and "zl"
  4900.     commands.
  4901.  
  4902.                         *'sidescrolloff'* *'siso'*
  4903. 'sidescrolloff' 'siso'    number (default 0)
  4904.             global
  4905.             {not in Vi}
  4906.     The minimal number of screen columns to keep to the left and to the
  4907.     right of the cursor if 'nowrap' is set. Setting this option to a value
  4908.     greater than 0 while having |'sidescroll'| also at a nonzero value
  4909.     makes some context visible in the line you are scrolling in
  4910.     horizontally (except at the end and beginning of the line).  Setting
  4911.     this option to a large value (like 999) has the effect of keeping the
  4912.     cursor horizontally centered in the window, as long as one does not
  4913.     come too close to the beginning or end of the line.
  4914.     NOTE: This option is set to 0 when 'compatible' is set.
  4915.  
  4916.     Example: Try this together with 'sidescroll' and 'listchars' as
  4917.          in the following example to never allow the cursor to move
  4918.          onto the 'extends' character:
  4919.  
  4920.          :set nowrap sidescroll=1 listchars=extends:>,frontextends:<
  4921.          :set sidescrolloff=1
  4922.  
  4923.  
  4924.             *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
  4925. 'smartcase' 'scs'    boolean    (default off)
  4926.             global
  4927.             {not in Vi}
  4928.     Override the 'ignorecase' option if the search pattern contains upper
  4929.     case characters.  Only used when the search pattern is typed and
  4930.     'ignorecase' option is on.  Used for the commands "/", "?", "n", "N",
  4931.     ":g" and ":s".  Not used for "*", "#", "gd", tag search, etc..  After
  4932.     "*" and "#" you can make 'smartcase' used by doing a "/" command,
  4933.     recalling the search pattern from history and hitting <Enter>.
  4934.     NOTE: This option is reset when 'compatible' is set.
  4935.  
  4936.                  *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
  4937. 'smartindent' 'si'    boolean    (default off)
  4938.             local to buffer
  4939.             {not in Vi}
  4940.             {not available when compiled without the
  4941.             |+smartindent| feature}
  4942.     Do smart autoindenting when starting a new line.  Works for C-like
  4943.     programs, but can also be used for other languages.  'cindent' does
  4944.     something like this, works better in most cases, but is more strict,
  4945.     see |C-indenting|.  When 'cindent' is on, setting 'si' has no effect.
  4946.     'indentexpr' is a more advanced alternative.
  4947.     Normally 'autoindent' should also be on when using 'smartindent'.
  4948.     An indent is automatically inserted:
  4949.     - After a line ending in '{'.
  4950.     - After a line starting with a keyword from 'cinwords'.
  4951.     - Before a line starting with '}' (only with the "O" command).
  4952.     When typing '}' as the first character in a new line, that line is
  4953.     given the same indent as the matching '{'.
  4954.     When typing '#' as the first character in a new line, the indent for
  4955.     that line is removed, the '#' is put in the first column.  The indent
  4956.     is restored for the next line.  If you don't want this, use this
  4957.     mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
  4958.     When using the ">>" command, lines starting with '#' are not shifted
  4959.     right.
  4960.     NOTE: 'smartindent' is reset when 'compatible' is set.  When 'paste'
  4961.     is set smart indenting is disabled.
  4962.  
  4963.                  *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
  4964. 'smarttab' 'sta'    boolean    (default off)
  4965.             global
  4966.             {not in Vi}
  4967.     When on, a <Tab> in front of a line inserts blanks according to
  4968.     'shiftwidth'.  'tabstop' is used in other places.
  4969.     When off a <Tab> always inserts blanks according to 'tabstop'.
  4970.     'shiftwidth' is only used for shifting text left or right
  4971.     |shift-left-right|.
  4972.     What gets inserted (a Tab or spaces) depends on the 'expandtab'
  4973.     option.  Also see |ins-expandtab|.  When 'expandtab' is not set, the
  4974.     number of spaces minimized by using <Tab>s.
  4975.     NOTE: This option is reset when 'compatible' is set.
  4976.  
  4977.                     *'softtabstop'* *'sts'*
  4978. 'softtabstop' 'sts'    number    (default 0)
  4979.             local to buffer
  4980.             {not in Vi}
  4981.     Number of spaces that a <Tab> counts for while performing editing
  4982.     operations, like inserting a <Tab> or using <BS>.  It "feels" like
  4983.     <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
  4984.     used.  This is useful to keep the 'ts' setting at its standard value
  4985.     of 8, while being able to edit like it is set to 'sts'.  However,
  4986.     commands like "x" still work on the actual characters.
  4987.     When 'sts' is zero, this feature is off.
  4988.     'softtabstop' is set to 0 when the 'paste' option is set.
  4989.     See also |ins-expandtab|.  When 'expandtab' is not set, the number of
  4990.     spaces is minimized by using <Tab>s.
  4991.     NOTE: This option is set to 0 when 'compatible' is set.
  4992.  
  4993.             *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
  4994. 'splitbelow' 'sb'    boolean    (default off)
  4995.             global
  4996.             {not in Vi}
  4997.             {not available when compiled without the +windows
  4998.             feature}
  4999.     When on, splitting a window will put the new window below the current
  5000.     one. |:split|
  5001.  
  5002.             *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
  5003. 'splitright' 'spr'    boolean    (default off)
  5004.             global
  5005.             {not in Vi}
  5006.             {not available when compiled without the +vertsplit
  5007.             feature}
  5008.     When on, splitting a window will put the new window right of the
  5009.     current one. |:vsplit|
  5010.  
  5011.                *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
  5012. 'startofline' 'sol'    boolean    (default on)
  5013.             global
  5014.             {not in Vi}
  5015.     When "on" the commands listed below move the cursor to the first
  5016.     blank of the line.  When off the cursor is kept in the same column
  5017.     (if possible).  This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
  5018.     CTRL-F, "G", "H", "M", "L", , and to the commands "d", "<<" and ">>"
  5019.     with a linewise operator, with "%" with a count and to buffer changing
  5020.     commands (CTRL-^, :bnext, :bNext, etc.).  Also for an Ex command that
  5021.     only has a line number, e.g., ":25" or ":+".
  5022.     In case of buffer changing commands the cursor is placed at the column
  5023.     where it was the last time the buffer was edited.
  5024.     NOTE: This option is set when 'compatible' is set.
  5025.  
  5026.                *'statusline'* *'stl'*
  5027. 'statusline' 'stl'    string    (default empty)
  5028.             global
  5029.             {not in Vi}
  5030.             {not available when compiled without the |+statusline|
  5031.             feature}
  5032.     When nonempty, this option determines the content of the status line.
  5033.     Also see |status-line|.
  5034.  
  5035.     The option consists of printf style '%' items interspersed with
  5036.     normal text.  Each status line item is of the form:
  5037.       %-0{minwid}.{maxwid}{item}
  5038.     All fields except the {item} is optional.  A single percent sign can
  5039.     be given as "%%".
  5040.  
  5041.     Note that the only effect of 'ruler' when this option is set (and
  5042.     'laststatus' is 2) is controlling the output of |CTRL-G|.
  5043.  
  5044.     field        meaning ~
  5045.     -        Left justify the item. The default is right justified
  5046.             when minwid is larger than the length of the item.
  5047.     0        Leading zeroes in numeric items. Overridden by '-'.
  5048.     minwid        Minimum width of the item, padding as set by '-' & '0'.
  5049.     maxwid        Maximum width of the item.  Truncation occurs with a '<'
  5050.             on the left for text items.  Numeric items will be
  5051.             shifted down to maxwid-2 digits followed by '>'number
  5052.             where number is the amount of missing digits, much like
  5053.             an exponential notation.
  5054.     item        A one letter code as described below.
  5055.  
  5056.     Following is a description of the possible statusline items.  The
  5057.     second character in "item" is the type:
  5058.         N for number
  5059.         S for string
  5060.         F for flags as described below
  5061.         - not applicable
  5062.  
  5063.     item  meaning ~
  5064.     f S   Path to the file in the buffer, relative to current directory.
  5065.     F S   Full path to the file in the buffer.
  5066.     t S   File name (tail) of file in the buffer.
  5067.     m F   Modified flag, text is " [+]" or " [-]" if 'modifiable' is off.
  5068.     M F   Modified flag, text is ",+" or ",-".
  5069.     r F   Readonly flag, text is " [RO]".
  5070.     R F   Readonly flag, text is ",RO".
  5071.     h F   Help buffer flag, text is " [help]".
  5072.     H F   Help buffer flag, text is ",HLP".
  5073.     w F   Preview window flag, text is " [Preview]".
  5074.     W F   Preview window flag, text is ",PRV".
  5075.     y F   Type of file in the buffer, e.g., " [vim]".  See 'filetype'.
  5076.     Y F   Type of file in the buffer, e.g., ",VIM".  See 'filetype'.
  5077.           {not available when compiled without |+autocmd| feature}
  5078.     k S   Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
  5079.           being used: "<keymap>"
  5080.     n N   Buffer number.
  5081.     b N   Value of byte under cursor.
  5082.     B N   As above, in hexadecimal.
  5083.     o N   Byte number in file of byte under cursor, first byte is 1.
  5084.           Mnemonic: Offset from start of file (with one added)
  5085.           {not available when compiled without |+byte_offset| feature}
  5086.     O N   As above, in hexadecimal.
  5087.     N N   Printer page number. (Only of use in the 'printheader' option.)
  5088.     l N   Line number.
  5089.     L N   Number of lines in buffer.
  5090.     c N   Column number.
  5091.     v N   Virtual column number.
  5092.     V N   Virtual column number as -{num}.  Not displayed if equal to 'c'.
  5093.     p N   Percentage through file in lines as in |CTRL-G|.
  5094.     P S   Percentage through file of displayed window.  This is like the
  5095.           percentage described for 'ruler'.  Always 3 in length.
  5096.     a S   Argument list status as in default title. ({current} of {max})
  5097.           Empty if the argument file count is zero or one.
  5098.     { NF  Evaluate expression between '{' and '}' and substitute result.
  5099.     ( -   Start of item group.  Can be used for setting the width and
  5100.           alignment of a section.  Must be followed by %) somewhere.
  5101.     ) -   End of item group.  No width fields allowed.
  5102.     < -   Where to truncate line if too long.  Default is at the start.
  5103.           No width fields allowed.
  5104.     = -   Separation point between left and right aligned items.
  5105.           No width fields allowed.
  5106.     * -   Set highlight group to User{N}, where {N} is taken from the
  5107.           minwid field. eg. %1*.  Restore normal highlight with %* or %0*.
  5108.           The difference between User{N} and StatusLine  will be applied
  5109.           to StatusLineNC for the statusline of non-current windows.
  5110.           The number N must be between 1 and 9.  See |hl-User1..9|
  5111.  
  5112.     Display of flags are controlled by the following heuristic:
  5113.     If a flag text starts with comma it is assumed that it wants to
  5114.     separate itself from anything but preceding plaintext.  If it starts
  5115.     with a space it is assumed that it wants to separate itself from
  5116.     anything but other flags.  That is: A leading comma is removed if the
  5117.     preceding character stems from plaintext.  A leading space is removed
  5118.     if the preceding character stems from another active flag. This will
  5119.     make a nice display when flags are used like in the examples below.
  5120.  
  5121.     When all items in a group becomes an empty string (ie. flags that are
  5122.     not set) and a minwid is not set for the group, the whole group will
  5123.     become empty.  This will make a group like the following disappear
  5124.     completely from the statusline when none of the flags are set. >
  5125.         :set statusline=...%(\ [%M%R%H]%)...
  5126. <
  5127.     Beware that an expression is evaluated each and every time the status
  5128.     line is displayed.  The current buffer and current window will be set
  5129.     temporarily to that of the window (and buffer) whose statusline is
  5130.     currently being drawn. The expression will evaluate in this context.
  5131.     The variable "actual_curbuf" is set to the 'bufnr()' number of the
  5132.     real current buffer.  The expression is evaluated in the |sandbox|.
  5133.  
  5134.     If the statusline is not updated when you want it (e.g., after setting
  5135.     a variable that's used in an expression), you can force an update by
  5136.     setting an option without changing its value.  Example: >
  5137.         :let &ro = &ro
  5138.  
  5139. <    A result of all digits is regarded a number for display purposes.
  5140.     Otherwise the result is taken as flag text and applied to the rules
  5141.     described above.
  5142.  
  5143.     Watch out for errors in expressions.  They may render Vim unusable !
  5144.     If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
  5145.     edit your .vimrc or whatever with "vim -u NONE" to get it right.
  5146.  
  5147.     Examples:
  5148.     Display byte count and byte value, modified flag in red. >
  5149.       :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
  5150.       :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
  5151. <    Emulate standard status line with 'ruler' set >
  5152.       :set statusline=%<%f%h%m%r%=%l,%c%V\ %P
  5153. <    Idem, but add ascii value of char under the cursor (like "ga") >
  5154.       :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
  5155. <    Display a ,GZ flag if a compressed file is loaded >
  5156.       :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
  5157. <    In the |:autocmd|'s: >
  5158.       :let b:gzflag = 1
  5159. <    And: >
  5160.       :unlet b:gzflag
  5161. <    And define this function: >
  5162.       :function VarExists(var, val)
  5163.       :    if exists(a:var) | return a:val | else | return '' | endif
  5164.       :endfunction
  5165. <
  5166.                         *'suffixes'* *'su'*
  5167. 'suffixes' 'su'        string    (default ".bak,~,.o,.h,.info,.swp,.obj")
  5168.             global
  5169.             {not in Vi}
  5170.     Files with these suffixes get a lower priority when multiple files
  5171.     match a wildcard.  See |suffixes|.  Commas can be used to separate the
  5172.     suffixes.  Spaces after the comma are ignored.  A dot is also seen as
  5173.     the start of a suffix.  To avoid a dot or comma being recognized as a
  5174.     separator, precede it with a backslash (see |option-backslash| about
  5175.     including spaces and backslashes).
  5176.     See 'wildignore' for completely ignoring files.
  5177.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  5178.     suffixes from the list.  This avoids problems when a future version
  5179.     uses another default.
  5180.  
  5181.                         *'suffixesadd'* *'sua'*
  5182. 'suffixesadd' 'sua'    string    (default "")
  5183.             local to buffer
  5184.             {not in Vi}
  5185.             {not available when compiled without the
  5186.             |+file_in_path| feature}
  5187.     Comma separated list of suffixes, which are used when searching for a
  5188.     file for the "gf", "[I", etc. commands.  Example: >
  5189.         :set suffixesadd=.java
  5190. <
  5191.                 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
  5192. 'swapfile' 'swf'    boolean (default on)
  5193.             local to buffer
  5194.             {not in Vi}
  5195.     Use a swapfile for the buffer.  This option can be reset when a
  5196.     swapfile is not wanted for a specific buffer.  For example, with
  5197.     confidential information that even root must not be able to access.
  5198.     Careful: All text will be in memory:
  5199.         - Don't use this for big files.
  5200.         - Recovery will be impossible!
  5201.     A swapfile will only be present when |'updatecount'| is non-zero and
  5202.     'swapfile' is set.
  5203.     When 'swapfile' is reset, the swap file for the current buffer is
  5204.     immediately deleted.  When 'swapfile' is set, and 'updatecount' is
  5205.     non-zero, a swap file is immediately created.
  5206.     Also see |swap-file| and |'swapsync'|.
  5207.  
  5208.     This option is used together with 'bufhidden' and 'buftype' to
  5209.     specify special kinds of buffers.   See |special-buffers|.
  5210.  
  5211.                         *'swapsync'* *'sws'*
  5212. 'swapsync' 'sws'    string    (default "fsync")
  5213.             global
  5214.             {not in Vi}
  5215.     When this option is not empty a swap file is synced to disk after
  5216.     writing to it.  This takes some time, especially on busy unix systems.
  5217.     When this option is empty parts of the swap file may be in memory and
  5218.     not written to disk.  When the system crashes you may lose more work.
  5219.     On Unix the system does a sync now and then without Vim asking for it,
  5220.     so the disadvantage of setting this option off is small.  On some
  5221.     systems the swap file will not be written at all.  For a unix system
  5222.     setting it to "sync" will use the sync() call instead of the default
  5223.     fsync(), which may work better on some systems.
  5224.  
  5225.                         *'switchbuf'* *'swb'*
  5226. 'switchbuf' 'swb'    string    (default "")
  5227.             global
  5228.             {not in Vi}
  5229.     This option controls the behavior when switching between buffers.
  5230.     Possible values (comma separated list):
  5231.        useopen    If included, jump to the first open window that
  5232.             contains the specified buffer (if there is one).
  5233.             Otherwise: Do not examine other windows.
  5234.             This setting is checked with |quickfix| commands, when
  5235.             jumping to errors (":cc", ":cn", "cp", etc.).  It is
  5236.             also used in all buffer related split commands, for
  5237.             example ":sbuffer", ":sbnext", or ":sbrewind".
  5238.        split    If included, split the current window before loading
  5239.             a buffer. Otherwise: do not split, use current window.
  5240.             Supported in |quickfix| commands that display errors.
  5241.  
  5242.                         *'syntax'* *'syn'*
  5243. 'syntax' 'syn'        string  (default emtpy)
  5244.             local to buffer
  5245.             {not in Vi}
  5246.             {not available when compiled without the |+syntax|
  5247.             feature}
  5248.     When this option is set, the syntax with this name is loaded, unless
  5249.     syntax highlighting has been switched off with ":syntax off".
  5250.     Otherwise this option does not always reflect the current syntax (the
  5251.     b:current_syntax variable does).
  5252.     This option is most useful in a modeline, for a file which syntax is
  5253.     not automatically recognized.  Example, for in an IDL file: >
  5254.         /* vim: set syntax=idl : */
  5255. <    To switch off syntax highlighting for the current file, use: >
  5256.         :set syntax=OFF
  5257. <    To switch syntax highlighting on according to the current value of the
  5258.     'filetype' option: >
  5259.         :set syntax=ON
  5260. <    What actually happens when setting the 'syntax' option is that the
  5261.     Syntax autocommand event is triggered with the value as argument.
  5262.     This option is not copied to another buffer, independent of the 's' or
  5263.     'S' flag in 'cpoptions'.
  5264.  
  5265.                     *'tabstop'* *'ts'*
  5266. 'tabstop' 'ts'        number    (default 8)
  5267.             local to buffer
  5268.     Number of spaces that a <Tab> in the file counts for.  Also see
  5269.     |:retab| command, and 'softtabstop' option.
  5270.  
  5271.     Note: Setting 'tabstop' to any other value than 8 can make your file
  5272.     appear wrong in many places (e.g., when printing it).
  5273.  
  5274.     There are four main ways to use tabs in Vim:
  5275.     1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
  5276.        (or 3 or whatever you prefer) and use 'noexpandtab'.  Then Vim
  5277.        will use a mix of tabs and spaces, but typing Tab and BS will
  5278.        behave like a tab appears every 4 (or 3) characters.
  5279.     2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
  5280.        'expandtab'.  This way you will always insert spaces.  The
  5281.        formatting will never be messed up when 'tabstop' is changed.
  5282.     3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
  5283.        |modeline| to set these values when editing the file again.  Only
  5284.        works when using Vim to edit the file.
  5285.     4. Always set 'tabstop' and 'shiftwidth' to the same value, and
  5286.        'noexpandtab'.  This should then work (for initial indents only)
  5287.        for any tabstop setting that people use.  It might be nice to have
  5288.        tabs after the first non-blank inserted as spaces if you do this
  5289.        though.  Otherwise aligned comments will be wrong when 'tabstop' is
  5290.        changed.
  5291.  
  5292.             *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
  5293. 'tagbsearch' 'tbs'    boolean    (default on)
  5294.             global
  5295.             {not in Vi}
  5296.     When searching for a tag (e.g., for the |:ta| command), Vim can either
  5297.     use a binary search or a linear search in a tags file.  Binary
  5298.     searching makes searching for a tag a LOT faster, but a linear search
  5299.     will find more tags if the tags file wasn't properly sorted.
  5300.     Vim normally assumes that your tags files are sorted, or indicate that
  5301.     they are not sorted.  Only when this is not the case does the
  5302.     'tagbsearch' option need to be switched off.
  5303.  
  5304.     When 'tagbsearch' is on, binary searching is first used in the tags
  5305.     files.  In certain situations, Vim will do a linear search instead for
  5306.     certain files, or retry all files with a linear search.  When
  5307.     'tagbsearch' is off, only a linear search is done.
  5308.  
  5309.     Linear searching is done anyway, for one file, when Vim finds a line
  5310.     at the start of the file indicating that it's not sorted: >
  5311.    !_TAG_FILE_SORTED    0    /some command/
  5312. <    [The whitespace before and after the '0' must be a single <Tab>]
  5313.  
  5314.     When a binary search was done and no match was found in any of the
  5315.     files listed in 'tags', and 'ignorecase' is set or a pattern is used
  5316.     instead of a normal tag name, a retry is done with a linear search.
  5317.     Tags in unsorted tags files, and matches with different case will only
  5318.     be found in the retry.
  5319.  
  5320.     When 'tagbsearch' is off, tags searching is slower when a full match
  5321.     exists, but faster when no full match exists.  Tags in unsorted tags
  5322.     files may only be found with 'tagbsearch' off.
  5323.     When the tags file is not sorted, or sorted in a wrong way (not on
  5324.     ASCII byte value), 'tagbsearch' should be off, or the line given above
  5325.     must be included in the tags file.
  5326.     This option doesn't affect commands that find all matching tags (e.g.,
  5327.     command-line completion and ":help").
  5328.     {Vi: always uses binary search in some versions}
  5329.  
  5330.                         *'taglength'* *'tl'*
  5331. 'taglength' 'tl'    number    (default 0)
  5332.             global
  5333.     If non-zero, tags are significant up to this number of characters.
  5334.  
  5335.             *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
  5336. 'tagrelative' 'tr'    boolean    (Vim default: on, Vi default: off)
  5337.             global
  5338.             {not in Vi}
  5339.     If on and using a tag file in another directory, file names in that
  5340.     tag file are relative to the directory where the tag file is.
  5341.     NOTE: This option is set to the Vi default value when 'compatible' is
  5342.     set and to the Vim default value when 'compatible' is reset.
  5343.  
  5344.                         *'tags'* *'tag'* *E433*
  5345. 'tags' 'tag'        string    (default "./tags,tags", when compiled with
  5346.                 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
  5347.             global or local to buffer |global-local|
  5348.     Filenames for the tag command, separated by spaces or commas.  To
  5349.     include a space or comma in a file name, precede it with a backslash
  5350.     (see |option-backslash| about including spaces and backslashes).
  5351.     When a file name starts with "./", the '.' is replaced with the path
  5352.     of the current file.  But only when the 'd' flag is not included in
  5353.     'cpoptions'.  Environment variables are expanded |:set_env|.  Also see
  5354.     |tags-option|.
  5355.     "*" and "**" Wildcards can be used to search for tags files in a
  5356.     directory tree.  See |file-searching|.  {not available when compiled
  5357.     without the |+path_extra| feature}
  5358.     If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
  5359.     files are also supported.  They are automatically recognized.  The
  5360.     default value becomes "./tags,./TAGS,tags,TAGS".  |emacs-tags|
  5361.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  5362.     file names from the list.  This avoids problems when a future version
  5363.     uses another default.
  5364.     {Vi: default is "tags /usr/lib/tags"}
  5365.  
  5366.                 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
  5367. 'tagstack' 'tgst'    boolean    (default on)
  5368.             global
  5369.             {not in all versions of Vi}
  5370.     When on, the |tagstack| is used normally.  When off, a ":tag" or
  5371.     ":tselect" command with an argument will not push the tag onto the
  5372.     tagstack.  A following ":tag" without an argument, a ":pop" command or
  5373.     any other command that uses the tagstack will use the unmodified
  5374.     tagstack, but does change the pointer to the active entry.
  5375.     Resetting this option is useful when using a ":tag" command in a
  5376.     mapping which should not change the tagstack.
  5377.  
  5378.                         *'term'*
  5379. 'term'            string    (default is $TERM, if that fails:
  5380.                       in the GUI: "builtin_gui"
  5381.                     on Amiga: "amiga"
  5382.                      on BeOS: "beos-ansi"
  5383.                       on Mac: "mac-ansi"
  5384.                      on MiNT: "vt52"
  5385.                        on MS-DOS: "pcterm"
  5386.                      on OS/2: "os2ansi"
  5387.                      on Unix: "ansi"
  5388.                       on VMS: "ansi"
  5389.                        on Win 32: "win32")
  5390.             global
  5391.     Name of the terminal.  Used for choosing the terminal control
  5392.     characters.  Environment variables are expanded |:set_env|.
  5393.     For example: >
  5394.         :set term=$TERM
  5395. <    See |termcap|.
  5396.  
  5397.                         *'termencoding'* *'tenc'*
  5398. 'termencoding' 'tenc'    string    (default "")
  5399.             global
  5400.             {only available when compiled with the |+multi_byte|
  5401.             feature}
  5402.             {not in Vi}
  5403.     Encoding used for the terminal.  This specifies what character
  5404.     encoding the keyboard produces and the display will understand.  For
  5405.     the GUI it only applies to the keyboard ('encoding' is used for the
  5406.     display).
  5407.     When empty, the same encoding is used as for the 'encoding' option.
  5408.     This is the normal value.
  5409.     Not all combinations for 'termencoding' and 'encoding' are valid.  See
  5410.     |encoding-table|.
  5411.     The value for this option must be supported by iconv().  When iconv()
  5412.     cannot handle the value, no conversion will be done and you will
  5413.     probably experience problems with non-ASCII characters.
  5414.     Example: You are working with the locale set to euc-jp (Japanese) and
  5415.     want to edit a UTF-8 file: >
  5416.         :let &termencoding = &encoding
  5417.         :set encoding=utf-8
  5418. <    You need to do this when your system has no locale support for UTF-8.
  5419.  
  5420.                         *'terse'* *'noterse'*
  5421. 'terse'            boolean    (default off)
  5422.             global
  5423.     When set: Add 's' flag to 'shortmess' option (this makes the message
  5424.     for a search that hits the start or end of the file not being
  5425.     displayed).  When reset: Remove 's' flag from 'shortmess' option.  {Vi
  5426.     shortens a lot of messages}
  5427.  
  5428.                    *'textauto'* *'ta'* *'notextauto'* *'nota'*
  5429. 'textauto' 'ta'        boolean    (Vim default: on, Vi default: off)
  5430.             global
  5431.             {not in Vi}
  5432.     This option is obsolete.  Use 'fileformats'.
  5433.     For backwards compatibility, when 'textauto' is set, 'fileformats' is
  5434.     set to the default value for the current system.  When 'textauto' is
  5435.     reset, 'fileformats' is made empty.
  5436.     NOTE: This option is set to the Vi default value when 'compatible' is
  5437.     set and to the Vim default value when 'compatible' is reset.
  5438.  
  5439.                    *'textmode'* *'tx'* *'notextmode'* *'notx'*
  5440. 'textmode' 'tx'        boolean    (MS-DOS, Win32 and OS/2: default on,
  5441.                  others: default off)
  5442.             local to buffer
  5443.             {not in Vi}
  5444.     This option is obsolete.  Use 'fileformat'.
  5445.     For backwards compatibility, when 'textmode' is set, 'fileformat' is
  5446.     set to "dos".  When 'textmode' is reset, 'fileformat' is set to
  5447.     "unix".
  5448.  
  5449.                         *'textwidth'* *'tw'*
  5450. 'textwidth' 'tw'    number    (default 0)
  5451.             local to buffer
  5452.             {not in Vi}
  5453.     Maximum width of text that is being inserted.  A longer line will be
  5454.     broken after white space to get this width.  A zero value disables
  5455.     this.  'textwidth' is set to 0 when the 'paste' option is set.  When
  5456.     'textwidth' is zero, 'wrapmargin' may be used.  See also
  5457.     'formatoptions' and |ins-textwidth|.
  5458.     NOTE: This option is set to 0 when 'compatible' is set.
  5459.  
  5460.                         *'thesaurus'* *'tsr'*
  5461. 'thesaurus' 'tsr'    string    (default "")
  5462.             global or local to buffer |global-local|
  5463.             {not in Vi}
  5464.     List of file names, separated by commas, that are used to lookup words
  5465.     for thesesaurus completion commands |i_CTRL-X_CTRL-T|.  Each line in
  5466.     the file should contain words with similar meaning, separated by
  5467.     non-keyword characters (white space is preferred).  Maximum line
  5468.     length is 510 bytes.
  5469.     To obtain a file to be used here, check out the wordlist FAQ at
  5470.     http://www.hyphenologist.co.uk .
  5471.     To include a comma in a file name precede it with a backslash.  Spaces
  5472.     after a comma are ignored, otherwise spaces are included in the file
  5473.     name.  See |option-backslash| about using backslashes.
  5474.     The use of |:set+=| and |:set-=| is preferred when adding or removing
  5475.     directories from the list.  This avoids problems when a future version
  5476.     uses another default.
  5477.     Backticks cannot be used in this option for security reasons.
  5478.  
  5479.                  *'tildeop'* *'top'* *'notildeop'* *'notop'*
  5480. 'tildeop' 'top'        boolean    (default off)
  5481.             global
  5482.             {not in Vi}
  5483.     When on: The tilde command "~" behaves like an operator.
  5484.     NOTE: This option is reset when 'compatible' is set.
  5485.  
  5486.                 *'timeout'* *'to'* *'notimeout'* *'noto'*
  5487. 'timeout' 'to'        boolean (default on)
  5488.             global
  5489.                         *'ttimeout'* *'nottimeout'*
  5490. 'ttimeout'        boolean (default off)
  5491.             global
  5492.             {not in Vi}
  5493.     These two options together determine the behavior when part of a
  5494.     mapped key sequence or keyboard code has been received:
  5495.  
  5496.     'timeout'    'ttimeout'        action    ~
  5497.        off        off        do not time out
  5498.        on        on or off    time out on :mappings and key codes
  5499.        off        on        time out on key codes
  5500.  
  5501.     If both options are off, Vim will wait until either the complete
  5502.     mapping or key sequence has been received, or it is clear that there
  5503.     is no mapping or key sequence for the received characters.  For
  5504.     example: if you have mapped "vl" and Vim has received 'v', the next
  5505.     character is needed to see if the 'v' is followed by an 'l'.
  5506.     When one of the options is on, Vim will wait for about 1 second for
  5507.     the next character to arrive.  After that the already received
  5508.     characters are interpreted as single characters.  The waiting time can
  5509.     be changed with the 'timeoutlen' option.
  5510.     On slow terminals or very busy systems timing out may cause
  5511.     malfunctioning cursor keys.  If both options are off, Vim waits
  5512.     forever after an entered <Esc> if there are key codes that start
  5513.     with <Esc>.  You will have to type <Esc> twice.  If you do not have
  5514.     problems with key codes, but would like to have :mapped key
  5515.     sequences not timing out in 1 second, set the 'ttimeout' option and
  5516.     reset the 'timeout' option.
  5517.  
  5518.     NOTE: 'ttimeout' is reset when 'compatible' is set.
  5519.  
  5520.                         *'timeoutlen'* *'tm'*
  5521. 'timeoutlen' 'tm'    number    (default 1000)
  5522.             global
  5523.             {not in all versions of Vi}
  5524.                         *'ttimeoutlen'* *'ttm'*
  5525. 'ttimeoutlen' 'ttm'    number    (default -1)
  5526.             global
  5527.             {not in Vi}
  5528.     The time in milliseconds that is waited for a key code or mapped key
  5529.     sequence to complete.  Normally only 'timeoutlen' is used and
  5530.     'ttimeoutlen' is -1.  When a different timeout value for key codes is
  5531.     desired set 'ttimeoutlen' to a non-negative number.
  5532.  
  5533.         ttimeoutlen    mapping delay       key code delay    ~
  5534.            < 0        'timeoutlen'       'timeoutlen'
  5535.           >= 0        'timeoutlen'       'ttimeoutlen'
  5536.  
  5537.     The timeout only happens when the 'timeout' and 'ttimeout' options
  5538.     tell so.  A useful setting would be
  5539.         :set timeout timeoutlen=3000 ttimeoutlen=100
  5540.     (time out on mapping after three seconds, time out on key codes after
  5541.     a tenth of a second).
  5542.  
  5543.                         *'title'* *'notitle'*
  5544. 'title'            boolean    (default off, on when title can be restored)
  5545.             global
  5546.             {not in Vi}
  5547.             {not available when compiled without the |+title|
  5548.             feature}
  5549.     When on, the title of the window will be set to the value of
  5550.     'titlestring' (if it is not empty), or to:
  5551.         filename [+=-] (path) - VIM
  5552.     Where:
  5553.         filename    the name of the file being edited
  5554.         -        indicates the file canot be modified, 'ma' off
  5555.         +        indicates the file was modified
  5556.         =        indicates the file is read-only
  5557.         =+        indicates the file is read-only and modified
  5558.         (path)        is the path of the file being edited
  5559.     Only works if the terminal supports setting window titles
  5560.     (currently Amiga console, Win32 console, all GUI versions and
  5561.     terminals with a non- empty 't_ts' option - these are Unix xterm and
  5562.     iris-ansi by default, where 't_ts' is taken from the builtin termcap).
  5563.                                 *X11*
  5564.     When Vim was compiled with HAVE_X11 defined, the original title will
  5565.     be restored if possible.  The output of ":version" will include "+X11"
  5566.     when HAVE_X11 was defined, otherwise it will be "-X11".  This also
  5567.     works for the icon name |'icon'|.
  5568.     But: When Vim was started with the |-X| argument, restoring the title
  5569.     will not work (except in the GUI).
  5570.     If the title cannot be restored, it is set to the value of 'titleold'.
  5571.     You might want to restore the title outside of Vim then.
  5572.     When using an xterm from a remote machine you can use this command:
  5573.         rsh machine_name xterm -display $DISPLAY &
  5574.     then the WINDOWID environment variable should be inherited and the
  5575.     title of the window should change back to what it should be after
  5576.     exiting Vim.
  5577.  
  5578.                                 *'titlelen'*
  5579. 'titlelen'        number    (default 85)
  5580.             global
  5581.             {not in Vi}
  5582.             {not available when compiled without the |+title|
  5583.             feature}
  5584.     Gives the percentage of 'columns' to use for the length of the window
  5585.     title.  When the title is longer, only the end of the path name is
  5586.     shown.  A '<' character before the path name is used to indicate this.
  5587.     Using a percentage makes this adapt to the width of the window.  But
  5588.     it won't work perfectly, because the actual number of characters
  5589.     available also depends on the font used and other things in the title
  5590.     bar.  When 'titlelen' is zero the full path is used.  Otherwise,
  5591.     values from 1 to 30000 percent can be used.
  5592.     'titlelen' is also used for the 'titlestring' option.
  5593.  
  5594.                         *'titleold'*
  5595. 'titleold'        string    (default "Thanks for flying Vim")
  5596.             global
  5597.             {not in Vi}
  5598.             {only available when compiled with the |+title|
  5599.             feature}
  5600.     This option will be used for the window title when exiting Vim if the
  5601.     original title cannot be restored.  Only happens if 'title' is on or
  5602.     'titlestring' is not empty.
  5603.                         *'titlestring'*
  5604. 'titlestring'        string    (default "")
  5605.             global
  5606.             {not in Vi}
  5607.             {not available when compiled without the |+title|
  5608.             feature}
  5609.     When this option is not empty, it will be used for the title of the
  5610.     window.  This happens only when the 'title' option is on.
  5611.     Only works if the terminal supports setting window titles (currently
  5612.     Amiga console, Win32 console, all GUI versions and terminals with a
  5613.     non-empty 't_ts' option).
  5614.     When Vim was compiled with HAVE_X11 defined, the original title will
  5615.     be restored if possible |X11|.
  5616.     When this option contains printf-style '%' items, they will be
  5617.     expanded according to the rules used for 'statusline'.
  5618.     Example: >
  5619.     :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
  5620.     :set title titlestring=%<%F%=%l/%L-%P titlelen=70
  5621. <    The value of 'titlelen' is used to align items in the middle or right
  5622.     of the available space.
  5623.     Some people prefer to have the file name first: >
  5624.     :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
  5625. <    Note the use of "%{ }" and an expression to get the path of the file,
  5626.     without the file name.  The "%( %)" constructs are used to add a
  5627.     separating space only when needed.
  5628.     NOTE: Use of special characters in 'titlestring' may cause the display
  5629.     to be garbled (e.g., when it contains a CR or NL character).
  5630.     {not available when compiled without the |+statusline| feature}
  5631.  
  5632.                 *'toolbar'* *'tb'*
  5633. 'toolbar' 'tb'        string    (default "icons,tooltips")
  5634.             global
  5635.             {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
  5636.             |+GUI_Photon|}
  5637.     The contents of this option controls various toolbar settings.  The
  5638.     possible values are:
  5639.         icons        Toolbar buttons are shown with icons.
  5640.         text        Toolbar buttons shown with text.
  5641.         tooltips    Tooltips are active for toolbar buttons.
  5642.     Tooltips refer to the popup help text which appears after the mouse
  5643.     cursor is placed over a toolbar button for a brief moment.
  5644.  
  5645.     If you want the toolbar to be shown with icons as well as text, do the
  5646.     following: >
  5647.         :set tb=icons,text
  5648. <    Motif and Athena cannot display icons and text at the same time.  They
  5649.     will show icons if both are requested.
  5650.  
  5651.     If none of the strings specified in 'toolbar' are valid or if
  5652.     'toolbar' is empty, this option is ignored.  If you want to disable
  5653.     the toolbar, you need to set the 'guioptions' option.  For example: >
  5654.         :set guioptions-=T
  5655. <    Also see |gui-toolbar|.
  5656.  
  5657.                  *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
  5658. 'ttybuiltin' 'tbi'    boolean    (default on)
  5659.             global
  5660.             {not in Vi}
  5661.     When on, the builtin termcaps are searched before the external ones.
  5662.     When off the builtin termcaps are searched after the external ones.
  5663.     When this option is changed, you should set the 'term' option next for
  5664.     the change to take effect, for example: >
  5665.         :set notbi term=$TERM
  5666. <    See also |termcap|.
  5667.     Rationale: The default for this option is "on", because the builtin
  5668.     termcap entries are generally better (many systems contain faulty
  5669.     xterm entries...).
  5670.  
  5671.                      *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
  5672. 'ttyfast' 'tf'        boolean    (default off, on when 'term' is xterm, hpterm,
  5673.                     sun-cmd, screen, rxvt, dtterm or
  5674.                     iris-ansi; also on when running Vim in
  5675.                     a DOS console)
  5676.             global
  5677.             {not in Vi}
  5678.     Indicates a fast terminal connection.  More characters will be sent to
  5679.     the screen for redrawing, instead of using insert/delete line
  5680.     commands.  Improves smoothness of redrawing when there are multiple
  5681.     windows and the terminal does not support a scrolling region.
  5682.     Also enables the extra writing of characters at the end of each screen
  5683.     line for lines that wrap.  This helps when using copy/paste with the
  5684.     mouse in an xterm and other terminals.
  5685.  
  5686.                         *'ttymouse'* *'ttym'*
  5687. 'ttymouse' 'ttym'    string    (default depends on 'term')
  5688.             global
  5689.             {not in Vi}
  5690.             {only in Unix and VMS, doesn't work in the GUI; not
  5691.             available when compiled without |+mouse|}
  5692.     Name of the terminal type for which mouse codes are to be recognized.
  5693.     Currently these three strings are valid:
  5694.                             *xterm-mouse*
  5695.        xterm    xterm-like mouse handling.  The mouse generates
  5696.             "<Esc>[Mscr", where "scr" is three bytes:
  5697.                 "s"  = button state
  5698.                 "c"  = column plus 33
  5699.                 "r"  = row plus 33
  5700.        xterm2    Works like "xterm", but with the xterm reporting the
  5701.             mouse position while the mouse is dragged.  This works
  5702.             much faster and more precise.  Your xterm must at
  5703.             least at patchlevel 88  / XFree 3.3.3 for this to
  5704.             work.  See below for how Vim detects this
  5705.             automatically.
  5706.                             *netterm-mouse*
  5707.        netterm    NetTerm mouse handling.  The mouse generates
  5708.             "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
  5709.             for the row and column.
  5710.                             *dec-mouse*
  5711.        dec        DEC terminal mouse handling.  The mouse generates a
  5712.             rather complex sequence, starting with "<Esc>[".
  5713.  
  5714.     The mouse handling must be enabled at compile time |+mouse_xterm|
  5715.     |+mouse_dec| |+mouse_netterm|.
  5716.     Only "xterm"(2) is really recognized.  NetTerm mouse codes are always
  5717.     recognized, if enabled at compile time.  DEC terminal mouse codes
  5718.     are recognized if enabled at compile time, and 'ttymouse' is not
  5719.     "xterm" (because the xterm and dec mouse codes conflict).
  5720.     This option is automatically set to "xterm", when the 'term' option is
  5721.     set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
  5722.     or "xterm2" already.  The main use of this option is to set it to
  5723.     "xterm", when the terminal name doesn't start with "xterm", but it can
  5724.     handle xterm mouse codes.
  5725.     The "xterm2" value will be set if the xterm version is reported to be
  5726.     95 of higher.  This only works when compiled with the |+termresponse|
  5727.     feature and if |t_RV| is set to the escape sequence to request the
  5728.     xterm version number.  Otherwise "xterm2" must be set explicitly.
  5729.     If you do not want 'ttymouse' to be set to "xterm2" automatically, set
  5730.     t_RV to an empty string: >
  5731.         :set t_RV=
  5732. <
  5733.                         *'ttyscroll'* *'tsl'*
  5734. 'ttyscroll' 'tsl'    number    (default 999)
  5735.             global
  5736.     Maximum number of lines to scroll the screen.  If there are more lines
  5737.     to scroll the window is redrawn.  For terminals where scrolling is
  5738.     very slow and redrawing is not slow this can be set to a small number,
  5739.     e.g., 3, to speed up displaying.
  5740.  
  5741.                         *'ttytype'* *'tty'*
  5742. 'ttytype' 'tty'        string    (default from $TERM)
  5743.             global
  5744.     Alias for 'term', see above.
  5745.  
  5746.                         *'undolevels'* *'ul'*
  5747. 'undolevels' 'ul'    number    (default 100, 1000 for Unix, VMS,
  5748.                         Win32 and OS/2)
  5749.             global
  5750.             {not in Vi}
  5751.     Maximum number of changes that can be undone.  Since undo information
  5752.     is kept in memory, higher numbers will cause more memory to be used
  5753.     (nevertheless, a single change can use an unlimited amount of memory).
  5754.     Set to 0 for Vi compatibility: One level of undo and "u" undoes
  5755.     itself: >
  5756.         set ul=0
  5757. <    But you can also get Vi compatibility by including the 'u' flag in
  5758.     'cpoptions', and still be able to use CTRL-R to repeat undo.
  5759.     Set to a negative number for no undo at all: >
  5760.         set ul=-1
  5761. <    This helps when you run out of memory for a single change.
  5762.     Also see |undo-two-ways|.
  5763.  
  5764.                         *'updatecount'* *'uc'*
  5765. 'updatecount' 'uc'    number    (default: 200)
  5766.             global
  5767.             {not in Vi}
  5768.     After typing this many characters the swap file will be written to
  5769.     disk.  When zero, no swap file will be created at all (see chapter on
  5770.     recovery |crash-recovery|).  'updatecount' is set to zero by starting
  5771.     Vim with the "-n" option, see |startup|.  When editing in readonly
  5772.     mode this option will be initialized to 10000.
  5773.     The swapfile can be disabled per buffer with |'swapfile'|.
  5774.     When 'updatecount' is set from non-zero to zero, swap files are
  5775.     created for all buffers that have 'swapfile' set.  When 'updatecount'
  5776.     is set to zero, existing swap files are not deleted.
  5777.     Also see |'swapsync'|.
  5778.     This option has no meaning in buffers where |'buftype'| is "nofile"
  5779.     or "nowrite".
  5780.  
  5781.                         *'updatetime'* *'ut'*
  5782. 'updatetime' 'ut'    number    (default 4000)
  5783.             global
  5784.             {not in Vi}
  5785.     If this many milliseconds nothing is typed the swap file will be
  5786.     written to disk (see |crash-recovery|).  Also used for the
  5787.     |CursorHold| autocommand event.
  5788.  
  5789.                         *'verbose'* *'vbs'*
  5790. 'verbose' 'vbs'        number    (default 0)
  5791.             global
  5792.             {not in Vi, although some versions have a boolean
  5793.             verbose option}
  5794.     When bigger than zero, Vim will give messages about what it is doing.
  5795.     Currently, these messages are given:
  5796.     >= 1    When the viminfo file is read or written.
  5797.     >= 2    When a file is ":source"'ed.
  5798.     >= 5    Every searched tags file.
  5799.     >= 8    Files for which a group of autocommands is executed.
  5800.     >= 9    Every executed autocommand.
  5801.     >= 12    Every executed function
  5802.     >= 15    Every executed Ex command (truncated at 200 characters)
  5803.  
  5804.     This option can also be set with the "-V" argument.  See |-V|.
  5805.     This option is also set by the |:verbose| command.
  5806.  
  5807.                         *'viewdir'* *'vdir'*
  5808. 'viewdir' 'vdir'    string    (default for Amiga, MS-DOS, OS/2 and Win32:
  5809.                              "$VIM/vimfiles/view",
  5810.                  for Unix: "~/.vim/view",
  5811.                  for Macintosh: "$VIM:vimfiles:view"
  5812.                  for VMS: "sys$login:vimfiles/view"
  5813.                  for RiscOS: "Choices:vimfiles/view")
  5814.             global
  5815.             {not in Vi}
  5816.             {not available when compiled without the +mksession
  5817.             feature}
  5818.     Name of the directory where to store files for |:mkview|.
  5819.     This option cannot be set from a |modeline|, for security reasons.
  5820.  
  5821.                         *'viewoptions'* *'vop'*
  5822. 'viewoptions' 'vop'    string    (default: "folds,options,cursor")
  5823.             global
  5824.             {not in Vi}
  5825.             {not available when compiled without the +mksession
  5826.             feature}
  5827.     Changes the effect of the |:mkview| command.  It is a comma separated
  5828.     list of words.  Each word enables saving and restoring something:
  5829.        word        save and restore ~
  5830.        cursor    cursor position in file and in window
  5831.        folds    manually created folds, opened/closed folds and local
  5832.             fold options
  5833.        options    options and mappings local to a window or buffer (not
  5834.             global values for local options)
  5835.        unix        with Unix end-of-line format (single <NL>), even when
  5836.             on Windows or DOS
  5837.  
  5838.     "slash" and "unix" are useful on Windows when sharing view files
  5839.     with Unix.  The Unix version of Vim cannot source dos format scripts,
  5840.     but the Windows version of Vim can source unix format scripts.
  5841.  
  5842.                         *'viminfo'* *'vi'*
  5843.  
  5844. 'viminfo' 'vi'        string    (Vi default: "", Vim default for MS-DOS,
  5845.                     Windows and OS/2: '20,"50,h,rA:,rB:,
  5846.                     for Amiga: '20,"50,h,rdf0:,rdf1:,rdf2:
  5847.                     for others: '20,"50,h)
  5848.             global
  5849.             {not in Vi}
  5850.             {not available when compiled without the  |+viminfo|
  5851.             feature}
  5852.     When non-empty, the viminfo file is read upon startup and written
  5853.     when exiting Vim (see |viminfo-file|).  The string should be a comma
  5854.     separated list of parameters, each consisting of a single character
  5855.     identifying the particular parameter, followed by a number or string
  5856.     which specifies the value of that parameter.  If a particular
  5857.     character is left out, then the default value is used for that
  5858.     parameter.  The following is a list of the identifying characters and
  5859.     the effect of their value.
  5860.     CHAR    VALUE    ~
  5861.     !    When included, save and restore global variables that start
  5862.         with an uppercase letter, and don't contain a lowercase
  5863.         letter.  Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
  5864.         and "_K_L_M" are not.
  5865.     "    Maximum number of lines saved for each register.  If zero then
  5866.         registers are not saved.  When not included, all lines are
  5867.         saved.  Dont forget to put a backslash before the ", otherwise
  5868.         it will be recognized as the start of a comment!
  5869.     %    When included, save and restore the buffer list.  If Vim is
  5870.         started with a file name argument, the buffer list is not
  5871.         restored.  If Vim is started without a file name argument, the
  5872.         buffer list is restored from the viminfo file.  Buffers
  5873.         without a file name and buffers for help files are not written
  5874.         to the viminfo file.
  5875.     '    Maximum number of previously edited files for which the marks
  5876.         are remembered.  This parameter must always be included when
  5877.         'viminfo' is non-empty.
  5878.         Including this item also means that the |jumplist| is stored
  5879.         in the viminfo file.
  5880.     /    Maximum number of items in the search pattern history to be
  5881.         saved.  If non-zero, then the previous search and substitute
  5882.         patterns are also saved.  When not included, the value of
  5883.         'history' is used.
  5884.     :    Maximum number of items in the command-line history to be
  5885.         saved.  When not included, the value of 'history' is used.
  5886.     @    Maximum number of items in the input-line history to be
  5887.         saved.  When not included, the value of 'history' is used.
  5888.     c    When included, convert the text in the viminfo file from the
  5889.         'encoding' used when writing the file to the current
  5890.         'encoding'. See |viminfo-encoding|.
  5891.     f    Whether file marks need to be stored.  If zero, file marks ('0
  5892.         to '9, 'A to 'Z) are not stored.  When not present or when
  5893.         non-zero, they are all stored.  '0 is used for the current
  5894.         cursor position (when exiting or when doing ":wviminfo").
  5895.     h    Disable the effect of 'hlsearch' when loading the viminfo
  5896.         file.  When not included, it depends on whether ":nohlsearch"
  5897.         has been used since the last search command.
  5898.     n    Name of the viminfo file.  The name must immediately follow
  5899.         the 'n'.  Must be the last one!  If the "-i" argument was
  5900.         given when starting Vim, that file name overrides the one
  5901.         given here with 'viminfo'.  Environment variables are expanded
  5902.         when opening the file, not when setting the option.
  5903.     r    Removable media.  The argument is a string (up to the next
  5904.         ',').  This parameter can be given several times.  Each
  5905.         specifies the start of a path for which no marks will be
  5906.         stored.  This is to avoid removable media.  For MS-DOS you
  5907.         could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:".  Case is
  5908.         ignored.  Maximum length of each 'r' argument is 50
  5909.         characters.
  5910.  
  5911.     Example: >
  5912.         :set viminfo='50,\"1000,:0,n~/vim/viminfo
  5913. <
  5914.     '50        Marks will be remembered for the last 50 files you
  5915.             edited.
  5916.     "1000        Contents of registers (up to 1000 lines each) will be
  5917.             remembered.
  5918.     :0        Command-line history will not be saved.
  5919.     n~/vim/viminfo    The name of the file to use is "~/vim/viminfo".
  5920.     no /        Since '/' is not specified, the default will be used,
  5921.             that is, save all of the search history, and also the
  5922.             previous search and substitute patterns.
  5923.     no %        The buffer list will not be saved nor read back.
  5924.     no h        'hlsearch' highlighting will be restored.
  5925.  
  5926.     This option cannot be set from a |modeline|, for security reasons.
  5927.  
  5928.                         *'virtualedit'* *'ve'*
  5929. 'virtualedit' 've'    string  (default "")
  5930.             global
  5931.             {not in Vi}
  5932.             {not available when compiled without the
  5933.             |+virtualedit| feature}
  5934.     A comma separated list of these words:
  5935.         block    Allow virtual editing in Visual block mode.
  5936.         insert    Allow virtual editing in Insert mode.
  5937.         all        Allow virtual editing in all modes.
  5938.     Virtual editing means that the cursor can be positioned where there is
  5939.     no actual character.  This can be halfway into a Tab or beyond the end
  5940.     of the line.  Useful for selecting a rectangle in Visual mode and
  5941.     editing a table.
  5942.  
  5943.             *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
  5944. 'visualbell' 'vb'    boolean    (default off)
  5945.             global
  5946.             {not in Vi}
  5947.     Use visual bell instead of beeping.  The terminal code to display the
  5948.     visual bell is given with 't_vb'.  When no beep or flash is wanted,
  5949.     use ":set vb t_vb=".
  5950.     Note: When the GUI starts, 't_vb' is reset to its default value.  You
  5951.     might want to set it again in your |gvimrc|.
  5952.     In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
  5953.     for 20 msec.  If you want to use a different time, use "<Esc>|40f",
  5954.     where 40 is the time in msec.
  5955.     Does not work on the Amiga, you always get a screen flash.
  5956.     Also see 'errorbells'.
  5957.  
  5958.                         *'warn'* *'nowarn'*
  5959. 'warn'            boolean    (default on)
  5960.             global
  5961.     Give a warning message when a shell command is used while the buffer
  5962.     has been changed.
  5963.  
  5964.              *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
  5965. 'weirdinvert' 'wiv'    boolean    (default off)
  5966.             global
  5967.             {not in Vi}
  5968.     This option has the same effect as the 't_xs' termcap option.
  5969.     It is provided for backwards compatibility with version 4.x.
  5970.     Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
  5971.     vice versa.  Has no effect when the GUI is running.
  5972.  
  5973.                         *'whichwrap'* *'ww'*
  5974. 'whichwrap' 'ww'    string    (Vim default: "b,s", Vi default: "")
  5975.             global
  5976.             {not in Vi}
  5977.     Allow specified keys that move the cursor left/right to wrap to the
  5978.     previous/next line when the cursor is on the first/last character in
  5979.     the line.  Concatenate characters to allow this for these keys:
  5980.         char   key      mode    ~
  5981.          b    <BS>     Normal and Visual
  5982.          s    <Space>     Normal and Visual
  5983.          h    "h"     Normal and Visual
  5984.          l    "l"     Normal and Visual
  5985.          <    <Left>     Normal and Visual
  5986.          >    <Right>     Normal and Visual
  5987.          ~    "~"     Normal
  5988.          [    <Left>     Insert and Replace
  5989.          ]    <Right>     Insert and Replace
  5990.     For example: >
  5991.         :set ww=<,>,[,]
  5992. <    allows wrap only when cursor keys are used.
  5993.     When the movement keys are used in combination with a delete or change
  5994.     operator, the <EOL> also counts for a character.  This makes "3h"
  5995.     different from "3dh" when the cursor crosses the end of a line.  This
  5996.     is also true for "x" and "X", because they do the same as "dl" and
  5997.     "dh".  If you use this, you may also want to use the mapping
  5998.     ":map <BS> X" to make backspace delete the character in front of the
  5999.     cursor.
  6000.     When 'l' is included, you get a side effect: "yl" on an empty line
  6001.     will include the <EOL>, so that "p" will insert a new line.
  6002.     NOTE: This option is set to the Vi default value when 'compatible' is
  6003.     set and to the Vim default value when 'compatible' is reset.
  6004.  
  6005.                         *'wildchar'* *'wc'*
  6006. 'wildchar' 'wc'        number    (Vim default: <Tab>, Vi default: CTRL-E)
  6007.             global
  6008.             {not in Vi}
  6009.     Character you have to type to start wildcard expansion in the
  6010.     command-line, as specified with 'wildmode'.
  6011.     The character is not recognized when used inside a macro.  See
  6012.     'wildcharm' for that.
  6013.     Although 'wc' is a number option, you can set it to a special key: >
  6014.         :set wc=<Esc>
  6015. <    NOTE: This option is set to the Vi default value when 'compatible' is
  6016.     set and to the Vim default value when 'compatible' is reset.
  6017.  
  6018.                         *'wildcharm'* *'wcm'*
  6019. 'wildcharm' 'wcm'    number    (default: none (0))
  6020.             global
  6021.             {not in Vi}
  6022.     'wildcharm' works exactly like 'wildchar', except that it is
  6023.     recognized when used inside a macro. You can find "spare" command-line
  6024.     keys suitable for this option by looking at |ex-edit-index|. Normally
  6025.     you'll never actually type 'wildcharm', just use it in mappings that
  6026.     automatically invoke completion mode, e.g.: >
  6027.         :set wcm=<C-Z>
  6028.         :cmap ss so $vim/sessions/*.vim<C-Z>
  6029. <    Then after typing :ss you can use CTRL-P & CTRL-N.
  6030.  
  6031.                         *'wildignore'* *'wig'*
  6032. 'wildignore' 'wig'    string    (default "")
  6033.             global
  6034.             {not in Vi}
  6035.             {not available when compiled without the |+wildignore|
  6036.             feature}
  6037.     A list of file patterns.  A file that matches with one of these
  6038.     patterns is ignored when completing file or directory names.
  6039.     The pattern is used like with |:autocmd|, see |autocmd-patterns|.
  6040.     Also see 'suffixes'.
  6041.     Example: >
  6042.         :set wildignore=*.o,*.obj
  6043. <    The use of |:set+=| and |:set-=| is preferred when adding or removing
  6044.     a pattern from the list.  This avoids problems when a future version
  6045.     uses another default.
  6046.  
  6047.                 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
  6048. 'wildmenu' 'wmnu'    boolean    (default off)
  6049.             global
  6050.             {not in Vi}
  6051.             {not available if compiled without the |+wildmenu|
  6052.             feature}
  6053.     When 'wildmenu' is on, command-line completion operates in an enhanced
  6054.     mode.  On pressing 'wildchar' (usually <Tab>) to invoke completion,
  6055.     the possible matches are shown just above the command line, with the
  6056.     first match highlighted (overwriting the status line, if there is
  6057.     one).  Keys that show the previous/next match, such as <Tab> or
  6058.     CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
  6059.     When 'wildmode' is used, "wildmenu" mode is used where "full" is
  6060.     specified.  "longest" and "list" do not start "wildmenu" mode.
  6061.     If there are more matches than can fit in the line, a ">" is shown on
  6062.     the right and/or a "<" is shown on the left.  The status line scrolls
  6063.     as needed.
  6064.     The "wildmenu" mode is abandoned when a key is hit that is not used
  6065.     for selecting a completion.
  6066.     While the "wildmenu" is active the following keys have special
  6067.     meanings:
  6068.  
  6069.     <Left> <Right>    - select previous/next match (like CTRL-P/CTRL-N)
  6070.     <Down>        - in filename/menu name completion: move into a
  6071.               subdirectory or submenu.
  6072.     <CR>        - in menu completion, when the cursor is just after a
  6073.               dot: move into a submenu.
  6074.     <Up>        - in filename/menu name completion: move up into
  6075.               parent directory or parent menu.
  6076.  
  6077.     This makes the menus accessible from the console |console-menus|.
  6078.  
  6079.     If you prefer the <Left> and <Right> keys to move the cursor instead
  6080.     of selecting a different match, use this: >
  6081.         :cnoremap <Left> <Space><BS><Left>
  6082.         :cnoremap <Right> <Space><BS><Right>
  6083. <
  6084.     The "WildMenu" highlighting is used for displaying the current match
  6085.     |hl-WildMenu|.
  6086.  
  6087.                         *'wildmode'* *'wim'*
  6088. 'wildmode' 'wim'    string    (Vim default: "full")
  6089.             global
  6090.             {not in Vi}
  6091.     Completion mode that is used for the character specified with
  6092.     'wildchar'.  It is a comma separated list of up to four parts.  Each
  6093.     part specifies what to do for each consecutive use of 'wildchar.  The
  6094.     first part specifies the behavior for the first use of 'wildchar',
  6095.     The second part for the second use, etc.
  6096.     These are the possible values for each part:
  6097.     ""        Complete only the first match.
  6098.     "full"        Complete the next full match.  After the last match,
  6099.             the original string is used and then the first match
  6100.             again.
  6101.     "longest"    Complete till longest common string.  If this doesn't
  6102.             result in a longer string, use the next part.
  6103.     "longest:full"    Like "longest", but also start 'wildmenu' if it is
  6104.             enabled.
  6105.     "list"        When more than one match, list all matches.
  6106.     "list:full"    When more than one match, list all matches and
  6107.             complete first match.
  6108.     "list:longest"    When more than one match, list all matches and
  6109.             complete till longest common string.
  6110.     When there is only a single match, it is fully completed in all cases.
  6111.  
  6112.     Examples: >
  6113.         :set wildmode=full
  6114. <    Complete first full match, next match, etc. (the default) >
  6115.         :set wildmode=longest,full
  6116. <    Complete longest common string, then each full match >
  6117.         :set wildmode=list:full
  6118. <    List all matches and complete each full match >
  6119.         :set wildmode=list,full
  6120. <    List all matches without completing, then each full match >
  6121.         :set wildmode=longest,list
  6122. <    Complete longest common string, then list alternatives.
  6123.  
  6124.                         *'winaltkeys'* *'wak'*
  6125. 'winaltkeys' 'wak'    string    (default "menu")
  6126.             global
  6127.             {not in Vi}
  6128.             {only used in Win32, Motif, GTK and Photon GUI}
  6129.     Some GUI versions allow the access to menu entries by using the ALT
  6130.     key in combination with a character that appears underlined in the
  6131.     menu.  This conflicts with the use of the ALT key for mappings and
  6132.     entering special characters.  This option tells what to do:
  6133.       no    Don't use ALT keys for menus.  ALT key combinations can be
  6134.         mapped, but there is no automatic handling.  This can then be
  6135.         done with the |:simalt| command.
  6136.       yes    ALT key handling is done by the windowing system.  ALT key
  6137.         combinations cannot be mapped.
  6138.       menu    Using ALT in combination with a character that is a menu
  6139.         shortcut key, will be handled by the windowing system.  Other
  6140.         keys can be mapped.
  6141.     If the menu is disabled by excluding 'm' from 'guioptions', the ALT
  6142.     key is never used for the menu.
  6143.     In the Win32 version, the <F10> key is handled like this too, since
  6144.     Windows uses it to select a menu.
  6145.  
  6146.                         *'winheight'* *'wh'*
  6147. 'winheight' 'wh'    number    (default 1)
  6148.             global
  6149.             {not in Vi}
  6150.             {not available when compiled without the +windows
  6151.             feature}
  6152.     Minimal number of lines for the current window.  This is not a hard
  6153.     minimum, Vim will use less lines if there is not enough room.  If the
  6154.     current window is smaller, its size is increased, at the cost of the
  6155.     height of other windows.  Set it to 999 to make the current window
  6156.     always fill the screen.  Set it to a small number for normal editing.
  6157.     The height is not adjusted after one of the commands to change the
  6158.     height of the current window.
  6159.     'winheight' applies to the current window.  Use 'winminheight' to set
  6160.     the minimal height for other windows.
  6161.  
  6162.                         *'winminheight'* *'wmh'*
  6163. 'winminheight' 'wmh'    number    (default 1)
  6164.             global
  6165.             {not in Vi}
  6166.             {not available when compiled without the +windows
  6167.             feature}
  6168.     The minimal height of a window, when it's not the current window.
  6169.     This is a hard minimum, windows will never become smaller.
  6170.     When set to zero, windows may be "squashed" to zero lines (i.e. just a
  6171.     status bar) if necessary.  They will return to at least one line when
  6172.     they become active (since the cursor has to have somewhere to go.)
  6173.     Use 'winheight' to set the minimal height of the current window.
  6174.     This option is only checked when making a window smaller.  Don't use a
  6175.     large number, it will cause errors when opening more than a few
  6176.     windows.  A value of 0 to 3 is reasonable.
  6177.  
  6178.                         *'winminwidth'* *'wmw'*
  6179. 'winminwidth' 'wmw'    number    (default 1)
  6180.             global
  6181.             {not in Vi}
  6182.             {not available when compiled without the +vertsplit
  6183.             feature}
  6184.     The minimal width of a window, when it's not the current window.
  6185.     This is a hard minimum, windows will never become smaller.
  6186.     When set to zero, windows may be "squashed" to zero columns (i.e. just
  6187.     a vertical separator) if necessary.  They will return to at least one
  6188.     line when they become active (since the cursor has to have somewhere
  6189.     to go.)
  6190.     Use 'winwidth' to set the minimal width of the current window.
  6191.     This option is only checked when making a window smaller.  Don't use a
  6192.     large number, it will cause errors when opening more than a few
  6193.     windows.  A value of 0 to 12 is reasonable.
  6194.  
  6195.                         *'winwidth'* *'wiw'*
  6196. 'winwidth' 'wiw'    number    (default 20)
  6197.             global
  6198.             {not in Vi}
  6199.             {not available when compiled without the +vertsplit
  6200.             feature}
  6201.     Minimal number of columns for the current window.  This is not a hard
  6202.     minimum, Vim will use less columns if there is not enough room.  If the
  6203.     current window is smaller, its size is increased, at the cost of the
  6204.     width of other windows.  Set it to 999 to make the current window
  6205.     always fill the screen.  Set it to a small number for normal editing.
  6206.     The width is not adjusted after one of the commands to change the
  6207.     width of the current window.
  6208.     'winwidth' applies to the current window.  Use 'winminwidth' to set
  6209.     the minimal width for other windows.
  6210.  
  6211.                         *'wrap'* *'nowrap'*
  6212. 'wrap'            boolean    (default on)
  6213.             local to window
  6214.             {not in Vi}
  6215.     This option changes how text is displayed.  It doesn't change the text
  6216.     in the buffer, see 'textwidth' for that.
  6217.     When on, lines longer than the width of the window will wrap and
  6218.     displaying continues on the next line.  When off lines will not wrap
  6219.     and only part of long lines will be displayed.  When the cursor is
  6220.     moved to a part that is not shown, the screen will scroll
  6221.     horizontally.
  6222.     To make scrolling horizontally a bit more useful, try this: >
  6223.         :set sidescroll=5
  6224.         :set listchars+=precedes:<,extends:>
  6225. <    See 'sidescroll', 'listchars' and |wrap-off|.
  6226.  
  6227.                         *'wrapmargin'* *'wm'*
  6228. 'wrapmargin' 'wm'    number    (default 0)
  6229.             local to buffer
  6230.     Number of characters from the right window border where wrapping
  6231.     starts.  When typing text beyond this limit, an <EOL> will be inserted
  6232.     and inserting continues on the next line.  When 'textwidth' is
  6233.     non-zero, this option is not used.  See also 'formatoptions' and
  6234.     |ins-textwidth|.  {Vi: works differently and less useful}
  6235.  
  6236.                    *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
  6237. 'wrapscan' 'ws'        boolean    (default on)            *E384* *E385*
  6238.             global
  6239.     Searches wrap around the end of the file.
  6240.  
  6241.                            *'write'* *'nowrite'*
  6242. 'write'            boolean    (default on)
  6243.             global
  6244.             {not in Vi}
  6245.     Allows writing files.  When not set, writing a file is not allowed.
  6246.     Can be used for a view-only mode, where modifications to the text are
  6247.     still allowed.  Can be reset with the |-m| or |-M| command line
  6248.     argument.  Filtering text is still possible, even though this requires
  6249.     writing a temporary file.
  6250.  
  6251.                    *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
  6252. 'writeany' 'wa'        boolean    (default off)
  6253.             global
  6254.     Allows writing to any file with no need for "!" override.
  6255.  
  6256.                  *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
  6257. 'writebackup' 'wb'    boolean    (default on with |+writebackup| feature, off
  6258.                     otherwise)
  6259.             global
  6260.             {not in Vi}
  6261.     Make a backup before overwriting a file.  The backup is removed after
  6262.     the file was successfully written, unless the 'backup' option is
  6263.     also on.  Reset this option if your file system is almost full.  See
  6264.     |backup-table| for another explanation.
  6265.     When the 'backupskip' pattern matches, a backup is not made anyway.
  6266.     NOTE: This option is set to the default value when 'compatible' is
  6267.     set.
  6268.  
  6269.                         *'writedelay'* *'wd'*
  6270. 'writedelay' 'wd'    number    (default 0)
  6271.             global
  6272.             {not in Vi}
  6273.     The number of microseconds to wait for each character sent to the
  6274.     screen.  When non-zero, characters are sent to the terminal one by
  6275.     one.  For MS-DOS pcterm this does not work.  For debugging purposes.
  6276.  
  6277.  vim:tw=78:ts=8:ft=help:norl:
  6278.